| {t('rest.reference.status_code')} | diff --git a/components/search/SearchResults.module.scss b/components/search/SearchResults.module.scss new file mode 100644 index 000000000000..62b9b09aff16 --- /dev/null +++ b/components/search/SearchResults.module.scss @@ -0,0 +1,8 @@ +.search_result { + mark { + background-color: transparent; + font-weight: bold; + } + + word-wrap: break-word; +} diff --git a/components/search/SearchResults.tsx b/components/search/SearchResults.tsx index b3542a8ab916..fed636c92b8f 100644 --- a/components/search/SearchResults.tsx +++ b/components/search/SearchResults.tsx @@ -1,19 +1,24 @@ import { Box, Pagination, Text } from '@primer/react' import { SearchIcon } from '@primer/octicons-react' import { useRouter } from 'next/router' +import cx from 'classnames' import type { SearchResultsT, SearchResultHitT } from './types' import { useTranslation } from 'components/hooks/useTranslation' +import { useNumberFormatter } from 'components/hooks/useNumberFormatter' import { Link } from 'components/Link' import { useQuery } from 'components/hooks/useQuery' import { sendEvent, EventType } from 'components/lib/events' +import styles from './SearchResults.module.scss' + type Props = { results: SearchResultsT query: string } export function SearchResults({ results, query }: Props) { const { t } = useTranslation('search') + const { formatInteger } = useNumberFormatter() const pages = Math.ceil(results.meta.found.value / results.meta.size) const { page } = results.meta @@ -22,8 +27,8 @@ export function SearchResults({ results, query }: Props) {
|---|
| 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. |
OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "title": "Set team access restrictions", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "teams", + "in": "body", + "description": "The slug values for teams
", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example replacing a team in a branch protection rule", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "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", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" } }, - "teams": { - "type": "array", - "items": { + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { - "type": "integer" + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] }, "url": { - "type": "string" + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] }, - "html_url": { - "type": "string" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] }, "name": { - "type": "string" - }, - "slug": { - "type": "string" + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] }, "description": { + "description": "Description of the team", "type": [ "string", "null" + ], + "examples": [ + "A great team." ] }, - "privacy": { - "type": "string" - }, "permission": { - "type": "string" + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] }, - "members_url": { - "type": "string" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, "repositories_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] }, - "parent": { - "type": [ - "string", - "null" + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + } + } + } + ], + "previews": [], + "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. |
OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "title": "Remove team access restrictions", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "teams", + "in": "body", + "description": "The slug values for teams
", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example removing a team in a branch protection rule", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "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", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" } }, - "apps": { - "type": "array", - "items": { + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { - "type": "integer" - }, - "slug": { - "type": "string" + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] }, - "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", - "examples": [ - "\"\"" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "\"https://github.com/testorg-ea8ec76d71c3af4b\"" - ] - }, - "followers_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" - ] - }, - "subscriptions_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" - ] - }, - "organizations_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" - ] - }, - "received_events_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" - ] - }, - "type": { - "type": "string", - "examples": [ - "\"Organization\"" - ] - }, - "site_admin": { - "type": "boolean", - "examples": [ - false - ] - } - } + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] }, "name": { - "type": "string" + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] }, "description": { - "type": "string" + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] }, - "external_url": { - "type": "string" + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] }, - "html_url": { - "type": "string" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] }, - "created_at": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, - "updated_at": { - "type": "string" + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] }, - "permissions": { - "type": "object", - "properties": { - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "issues": { - "type": "string" - }, - "single_file": { - "type": "string" - } - } + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] }, - "events": { - "type": "array", - "items": { - "type": "string" - } + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "apps_url", - "users", - "teams", - "apps" - ] - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false + ] + } }, - "block_creations": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "enabled" - ] - } - }, - "required": [ - "url" - ] + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } } } } ], "previews": [], - "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.
Note: The list of users, apps, and teams in total is limited to 100 items.
", + "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. |
OK
" }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, { "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" @@ -108190,9 +144526,9 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Delete branch protection", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "title": "Get users with access to the protected branch", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -108216,7 +144552,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -108240,29 +144576,216 @@ } }, "response": { - "statusCode": "204", - "description": "Response
" + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + } } } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { - "httpStatusCode": "204", - "description": "No Content
" + "httpStatusCode": "200", + "description": "OK
" }, { - "httpStatusCode": "403", - "description": "Forbidden
" + "httpStatusCode": "404", + "description": "Resource not found
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "title": "Get admin branch protection", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "title": "Add user access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -108286,7 +144809,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -108295,14 +144818,28 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "array of strings", + "name": "users", + "in": "body", + "description": "The username for users
", + "isRequired": true + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -108313,51 +144850,213 @@ "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true - }, + "example": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], "schema": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "url", - "enabled" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } } } ], "previews": [], - "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.
", + "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. |
OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "title": "Set admin branch protection", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "title": "Set user access restrictions", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -108381,7 +145080,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -108390,14 +145089,28 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "array of strings", + "name": "users", + "in": "body", + "description": "The username for users
", + "isRequired": true + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -108408,53 +145121,490 @@ "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true + "example": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + } + } + } + ], + "previews": [], + "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. |
OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "title": "Remove user access restrictions", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "users", + "in": "body", + "description": "The username for users
", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example removing a user in a branch protection rule", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], "schema": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "url", - "enabled" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } } } } ], "previews": [], - "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.
", + "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. |
OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] - }, + } + ] + }, + "checks": { + "runs": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "title": "Delete admin branch protection", - "category": "branches", - "subcategory": "branch-protection", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/check-runs", + "title": "Create a check run", + "category": "checks", + "subcategory": "runs", "parameters": [ { "name": "owner", @@ -108473,3006 +145623,2616 @@ "schema": { "type": "string" } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } } ], - "previews": [], - "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.
", - "statusCodes": [ + "bodyParameters": [ { - "httpStatusCode": "204", - "description": "No Content
" + "type": "string", + "name": "name", + "in": "body", + "description": "The name of the check. For example, \"code-coverage\".
", + "isRequired": true }, { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "title": "Get pull request review protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string", + "name": "head_sha", + "in": "body", + "description": "The SHA of the commit.
", + "isRequired": true }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string", + "name": "details_url", + "in": "body", + "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": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", - "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", - "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2 - }, - "schema": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "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": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "apps": { - "description": "The list of apps with review dismissal access.", - "type": "array", - "items": { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } - }, - "url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" - ] - }, - "users_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" - ] - }, - "teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" - ] - } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", - "examples": [ - true - ] - }, - "require_code_owner_reviews": { - "type": "boolean", - "examples": [ - true - ] - }, - "required_approving_review_count": { - "type": "integer", - "minimum": 1, - "maximum": 6, - "examples": [ - 2 - ] - } - }, - "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" - ] - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ + "type": "string", + "name": "external_id", + "in": "body", + "description": "A reference for the run on the integrator's system.
" + }, { - "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "title": "Update pull request review protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ + "type": "string", + "name": "status", + "in": "body", + "description": "The current status.
", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "default": "queued" + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string", + "name": "started_at", + "in": "body", + "description": "The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string", + "name": "conclusion", + "in": "body", + "description": "Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ + "type": "string", + "name": "completed_at", + "in": "body", + "description": "The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Specify which users, teams, and apps 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.
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.
The list of user logins with dismissal access
The title of the check run.
", + "isRequired": true }, { - "type": "array of strings", - "name": "teams", - "description": "The list of team slugs with dismissal access
The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
", + "isRequired": true }, { - "type": "array of strings", - "name": "apps", - "description": "The list of app slugs with dismissal access
The details of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
" + }, + { + "type": "array of objects", + "name": "annotations", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run 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\".
", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The path of the file to add an annotation to. For example, assets/css/main.css.
The start line of the annotation. Line numbers start at 1.
", + "isRequired": true + }, + { + "type": "integer", + "name": "end_line", + "description": "The end line of the annotation.
", + "isRequired": true + }, + { + "type": "integer", + "name": "start_column", + "description": "The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.
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.
The level of the annotation.
", + "isRequired": true, + "enum": [ + "notice", + "warning", + "failure" + ] + }, + { + "type": "string", + "name": "message", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.
", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "The title that represents the annotation. The maximum size is 255 characters.
" + }, + { + "type": "string", + "name": "raw_details", + "description": "Details about this annotation. The maximum size is 64 KB.
" + } + ] + }, + { + "type": "array of objects", + "name": "images", + "description": "Adds images to the output displayed in the GitHub pull request UI.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alt", + "description": "The alternative text for the image.
", + "isRequired": true + }, + { + "type": "string", + "name": "image_url", + "description": "The full URL of the image.
", + "isRequired": true + }, + { + "type": "string", + "name": "caption", + "description": "A short image description.
" + } + ] } ] }, { - "type": "boolean", - "name": "dismiss_stale_reviews", - "in": "body", - "description": "Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
Blocks merging pull requests until code owners have reviewed.
" - }, - { - "type": "integer", - "name": "required_approving_review_count", + "type": "array of objects", + "name": "actions", "in": "body", - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.
" + "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. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "A short explanation of what this action would do. The maximum size is 40 characters.
", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.
", + "isRequired": true + } + ] } ], "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of an in_progress conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "octoapp" - ] - }, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "octoapp" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "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": "" + } }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "repo": "REPO" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", - "description": "Response
", + "description": "Response for in_progress conclusion
", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", - "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", - "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } + "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": "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" ] }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "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" + } + } + } + ] }, "schema": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", + "title": "CheckRun", + "description": "A check performed on the code of a given code change", "type": "object", "properties": { + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "external_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "42" + ] + }, "url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, - "dismissal_restrictions": { + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "details_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://example.com" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "output": { "type": "object", "properties": { - "users": { - "description": "The list of users with review dismissal access.", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "title": { + "type": [ + "string", + "null" + ] }, - "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" + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "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.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "check_suite": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ] + }, + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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" + } }, - "name": { + "additionalProperties": { "type": "string" }, - "slug": { + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { "type": "string" }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "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" }, - "permission": { + "sha": { "type": "string" }, - "permissions": { + "repo": { "type": "object", "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "id": { + "type": "integer" }, - "maintain": { - "type": "boolean" + "url": { + "type": "string" }, - "admin": { - "type": "boolean" + "name": { + "type": "string" } }, "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "id", + "url", + "name" ] } }, "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" + "ref", + "sha", + "repo" ] - } - }, - "apps": { - "description": "The list of apps with review dismissal access.", - "type": "array", - "items": { - "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.", + }, + "base": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] + "ref": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] + "sha": { + "type": "string" }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "repo": { "type": "object", "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "id": { + "type": "integer" }, - "contents": { + "url": { "type": "string" }, - "deployments": { + "name": { "type": "string" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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", + "url", + "name" ] } }, "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "ref", + "sha", + "repo" ] } }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { "url": { "type": "string", + "format": "uri", "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + "https://api.github.com/repos/octocat/example/deployments/1" ] }, - "users_url": { + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + "MDEwOkRlcGxveW1lbnQx" ] }, - "teams_url": { + "task": { + "description": "Parameter to specify a task to execute", "type": "string", "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + "deploy" ] - } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", - "examples": [ - true - ] - }, - "require_code_owner_reviews": { - "type": "boolean", - "examples": [ - true - ] - }, - "required_approving_review_count": { - "type": "integer", - "minimum": 1, - "maximum": 6, - "examples": [ - 2 + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "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.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" ] } }, "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" + "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" ] } } - } - ], - "previews": [], - "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.
OK
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "title": "Delete pull request review protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "title": "Get commit signature protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", + "key": "example-of-completed-conclusion", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Example of a completed conclusion", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "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" + } + ] + }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "repo": "REPO" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", - "description": "Response
", + "description": "Response for completed conclusion
", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", - "enabled": true + "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": "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" + } + } + } + ] }, "schema": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", + "title": "CheckRun", + "description": "A check performed on the code of a given code change", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", + "id": { + "description": "The id of the check.", + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + 21 ] }, - "enabled": { - "type": "boolean", + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", "examples": [ - true + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] - } - }, - "required": [ - "url", - "enabled" - ] - } - } - } - ], - "previews": [], - "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.
Note: You must enable branch protection to require signed commits.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "title": "Create commit signature protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", - "enabled": true - }, - "schema": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { + }, + "node_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + "MDg6Q2hlY2tSdW40" ] }, - "enabled": { - "type": "boolean", + "external_id": { + "type": [ + "string", + "null" + ], "examples": [ - true + "42" ] - } - }, - "required": [ - "url", - "enabled" - ] - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "title": "Delete commit signature protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Get status checks protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { + }, "url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + "https://api.github.com/repos/github/hello-world/check-runs/4" ] }, - "strict": { - "type": "boolean", + "html_url": { + "type": [ + "string", + "null" + ], "examples": [ - true + "https://github.com/github/hello-world/runs/4" ] }, - "contexts": { - "type": "array", - "items": { - "type": "string" - }, + "details_url": { + "type": [ + "string", + "null" + ], "examples": [ - "continuous-integration/travis-ci" + "https://example.com" ] }, - "contexts_url": { + "status": { + "description": "The phase of the lifecycle that the check is currently in.", "type": "string", - "format": "uri", + "enum": [ + "queued", + "in_progress", + "completed" + ], "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + "queued" ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts" - ] - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Update status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "in": "body", - "description": "Require branches to be up to date before merging.
" - }, - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "The list of status checks to require in order to merge into this branch
" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + "neutral" ] }, - "strict": { - "type": "boolean", + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - true + "2018-05-04T01:14:52Z" + ] + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": [ + "string", + "null" + ] + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "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.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "check_suite": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ] + }, + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } ] }, - "contexts": { + "pull_requests": { "type": "array", "items": { - "type": "string" - }, - "examples": [ - "continuous-integration/travis-ci" - ] + "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" + ] + } }, - "contexts_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts" - ] - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "The name of the status checks
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example adding status checks to a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "contexts": [ - "continuous-integration/travis-ci", - "continuous-integration/jenkins" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - "continuous-integration/travis-ci", - "continuous-integration/jenkins" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Set status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "The name of the status checks
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example updating status checks for a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Remove status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "The name of the status checks
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example removing status checks from a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "contexts": [ - "continuous-integration/travis-ci" + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "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.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + } + }, + "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" ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } } } } ], "previews": [], - "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.
", + "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.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" + "httpStatusCode": "201", + "description": "Created
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "title": "Get access restrictions", - "category": "branches", - "subcategory": "branch-protection", + "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "title": "Get a check run", + "category": "checks", + "subcategory": "runs", "parameters": [ { "name": "owner", @@ -111493,14 +148253,13 @@ } }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "name": "check_run_id", + "description": "The unique identifier of the check run.
", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } } ], "bodyParameters": [], @@ -111514,7 +148273,7 @@ "parameters": { "owner": "OWNER", "repo": "REPO", - "branch": "BRANCH" + "check_run_id": "CHECK_RUN_ID" } }, "response": { @@ -111522,18 +148281,41 @@ "contentType": "application/json", "description": "Response
", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", - "users": [ - { - "login": "octocat", + "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": "MDQ6VXNlcjE=", + "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": "", - "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -111541,907 +148323,1128 @@ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": false - } - ], - "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ + "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": [ { - "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" + "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" + } }, - "events": [ - "push", - "pull_request" - ] + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } } ] }, "schema": { - "title": "Branch Restriction Policy", - "description": "Branch Restriction Policy", + "title": "CheckRun", + "description": "A check performed on the code of a given code change", "type": "object", "properties": { - "url": { + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", "type": "string", - "format": "uri" + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] }, - "users_url": { + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDg6Q2hlY2tSdW40" + ] }, - "teams_url": { + "external_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "42" + ] + }, + "url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] }, - "apps_url": { + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "details_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://example.com" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", "type": "string", - "format": "uri" + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] }, - "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" - } + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": [ + "string", + "null" + ] + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] }, - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string" - }, - "parent": { - "type": [ - "string", - "null" - ] - } + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "check_suite": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" } - } + }, + "required": [ + "id" + ] }, - "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" + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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" + } }, - "avatar_url": { + "additionalProperties": { "type": "string" }, - "description": { + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { "type": "string" }, - "gravatar_id": { - "type": "string", - "examples": [ - "\"\"" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "\"https://github.com/testorg-ea8ec76d71c3af4b\"" - ] - }, - "followers_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" - ] - }, - "subscriptions_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" - ] - }, - "organizations_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" - ] - }, - "received_events_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" - ] - }, - "type": { - "type": "string", - "examples": [ - "\"Organization\"" - ] - }, - "site_admin": { - "type": "boolean", - "examples": [ - false - ] - } + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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\"" + ] } }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "external_url": { - "type": "string" - }, - "html_url": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "created_at": { - "type": "string" + "number": { + "type": "integer" }, - "updated_at": { + "url": { "type": "string" }, - "permissions": { + "head": { "type": "object", "properties": { - "metadata": { - "type": "string" - }, - "contents": { + "ref": { "type": "string" }, - "issues": { + "sha": { "type": "string" }, - "single_file": { - "type": "string" + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] } - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "required": [ - "url", - "users_url", - "teams_url", - "apps_url", - "users", - "teams", - "apps" - ] - } - } - } - ], - "previews": [], - "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.
OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "title": "Delete access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "title": "Get apps with access to the protected branch", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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" - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" + }, + "required": [ + "ref", + "sha", + "repo" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", + "base": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "ref": { + "type": "string" }, - "site_admin": { - "type": "boolean" + "sha": { + "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "ref", + "sha", + "repo" ] } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" - } + } + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] }, - "additionalProperties": { - "type": "string" + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "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.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + } }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + } + }, + "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" + ] } } } ], "previews": [], - "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.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "title": "Add app access restrictions", - "category": "branches", - "subcategory": "branch-protection", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "title": "Update a check run", + "category": "checks", + "subcategory": "runs", "parameters": [ { "name": "owner", @@ -112462,935 +149465,208 @@ } }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "name": "check_run_id", + "description": "The unique identifier of the check run.
", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } } ], "bodyParameters": [ { - "type": "array of strings", - "name": "apps", + "type": "string", + "name": "name", "in": "body", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "apps": [ - "octoapp" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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" - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } - } - } - } - ], - "previews": [], - "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.
The name of the check. For example, \"code-coverage\".
" + }, { - "httpStatusCode": "200", - "description": "OK
" + "type": "string", + "name": "details_url", + "in": "body", + "description": "The URL of the integrator's site that has the full details of the check.
" }, { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "title": "Set app access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ + "type": "string", + "name": "external_id", + "in": "body", + "description": "A reference for the run on the integrator's system.
" + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string", + "name": "started_at", + "in": "body", + "description": "This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string", + "name": "status", + "in": "body", + "description": "The current status.
", + "enum": [ + "queued", + "in_progress", + "completed" + ] }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ + "type": "string", + "name": "conclusion", + "in": "body", + "description": "Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.
The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ + "description": "The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
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.
Required.
" }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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 + { + "type": "string", + "name": "summary", + "description": "Can contain Markdown.
", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "Can contain Markdown.
" + }, + { + "type": "array of objects", + "name": "annotations", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run 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\".
", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "The path of the file to add an annotation to. For example, assets/css/main.css.
The start line of the annotation. Line numbers start at 1.
", + "isRequired": true }, - "events": [ - "push", - "pull_request" - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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\"" - ] - } + { + "type": "integer", + "name": "end_line", + "description": "The end line of the annotation.
", + "isRequired": true }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - } - ], - "previews": [], - "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.
OK
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "title": "Remove app access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + { + "type": "integer", + "name": "start_column", + "description": "The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.
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.
The level of the annotation.
", + "isRequired": true, + "enum": [ + "notice", + "warning", + "failure" + ] + }, + { + "type": "string", + "name": "message", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.
", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "The title that represents the annotation. The maximum size is 255 characters.
" + }, + { + "type": "string", + "name": "raw_details", + "description": "Details about this annotation. The maximum size is 64 KB.
" + } + ] + }, + { + "type": "array of objects", + "name": "images", + "description": "Adds images to the output displayed in the GitHub pull request UI.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alt", + "description": "The alternative text for the image.
", + "isRequired": true + }, + { + "type": "string", + "name": "image_url", + "description": "The full URL of the image.
", + "isRequired": true + }, + { + "type": "string", + "name": "caption", + "description": "A short image description.
" + } + ] + } + ] }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "apps", + "type": "array of objects", + "name": "actions", "in": "body", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. Note: The list of users, apps, and teams in total is limited to 100 items.
", - "isRequired": true + "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.\"
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "A short explanation of what this action would do. The maximum size is 40 characters.
", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.
", + "isRequired": true + } + ] } ], "enabledForGitHubApps": true, @@ -113402,22 +149678,77 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "apps": [ - "my-app" - ] + "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" + } + ] + } }, "parameters": { "owner": "OWNER", "repo": "REPO", - "branch": "BRANCH" + "check_run_id": "CHECK_RUN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": [ - { + "example": { + "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==", @@ -113457,649 +149788,1108 @@ "push", "pull_request" ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] + }, + "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" + } }, - "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" - } + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + }, + "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.", + "type": "integer", + "examples": [ + 21 + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "external_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "42" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "details_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://example.com" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": [ + "string", + "null" + ] }, - "additionalProperties": { - "type": "string" + "summary": { + "type": [ + "string", + "null" + ] }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" + "text": { + "type": [ + "string", + "null" + ] }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + } }, - "pem": { - "type": "string", - "examples": [ - "\"-----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": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - } - } - } - ], - "previews": [], - "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.
OK
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "title": "Get teams with access to the protected branch", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" + "name": { + "description": "The name of the check.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "check_suite": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + } }, - "permissions": { + "required": [ + "id" + ] + }, + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", "type": "object", "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "id": { + "type": "integer" }, - "maintain": { - "type": "boolean" + "number": { + "type": "integer" }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" + "url": { + "type": "string" }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "head": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] + "ref": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] + "sha": { + "type": "string" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "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" }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] + "sha": { + "type": "string" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" ] } }, "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "ref", + "sha", + "repo" ] } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" ] } }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "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.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + } + }, + "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" + ] } } } ], "previews": [], - "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.
", + "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.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "title": "Add team access restrictions", - "category": "branches", - "subcategory": "branch-protection", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "title": "List check run annotations", + "category": "checks", + "subcategory": "runs", "parameters": [ { "name": "owner", @@ -114120,42 +150910,45 @@ } }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "name": "check_run_id", + "description": "The unique identifier of the check run.
", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ + "type": "integer" + } + }, { - "type": "array of strings", - "name": "teams", - "in": "body", - "description": "The slug values for teams
", - "isRequired": true + "name": "per_page", + "description": "The number of 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 + } } ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Example adding a team in a branch protection rule", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "teams": [ - "justice-league" - ] - }, "parameters": { "owner": "OWNER", "repo": "REPO", - "branch": "BRANCH" + "check_run_id": "CHECK_RUN_ID" } }, "response": { @@ -114164,220 +150957,112 @@ "description": "Response
", "example": [ { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null + "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" } ], "schema": { "type": "array", "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Check Annotation", + "description": "Check Annotation", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { + "path": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "README.md" ] }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" + "start_line": { + "type": "integer", + "examples": [ + 2 + ] }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "end_line": { + "type": "integer", + "examples": [ + 2 + ] + }, + "start_column": { + "type": [ + "integer", + "null" + ], + "examples": [ + 5 + ] + }, + "end_column": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10 + ] + }, + "annotation_level": { + "type": [ + "string", + "null" + ], + "examples": [ + "warning" + ] + }, + "title": { + "type": [ + "string", + "null" + ], + "examples": [ + "Spell Checker" + ] + }, + "message": { + "type": [ + "string", + "null" + ], + "examples": [ + "Check your spelling for 'banaas'." ] + }, + "raw_details": { + "type": [ + "string", + "null" + ], + "examples": [ + "Do you mean 'bananas' or 'banana'?" + ] + }, + "blob_href": { + "type": "string" } }, "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" + "path", + "blob_href", + "start_line", + "end_line", + "start_column", + "end_column", + "annotation_level", + "title", + "message", + "raw_details" ] } } @@ -114385,25 +151070,21 @@ } ], "previews": [], - "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. |
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.
OK
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "title": "Set team access restrictions", - "category": "branches", - "subcategory": "branch-protection", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest", + "title": "Rerequest a check run", + "category": "checks", + "subcategory": "runs", "parameters": [ { "name": "owner", @@ -114424,290 +151105,72 @@ } }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "name": "check_run_id", + "description": "The unique identifier of the check run.
", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "teams", - "in": "body", - "description": "The slug values for teams
", - "isRequired": true + "type": "integer" + } } ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Example replacing a team in a branch protection rule", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "teams": [ - "justice-league" - ] - }, "parameters": { "owner": "OWNER", "repo": "REPO", - "branch": "BRANCH" + "check_run_id": "CHECK_RUN_ID" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "Response
", - "example": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], + "example": null, "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false } } } ], "previews": [], - "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. |
Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared.
To rerequest a check run, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
OK
" + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" }, { "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" + "description": "Validation error if the check run is not rerequestable
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "title": "Remove team access restrictions", - "category": "branches", - "subcategory": "branch-protection", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "title": "List check runs in a check suite", + "category": "checks", + "subcategory": "runs", "parameters": [ { "name": "owner", @@ -114728,818 +151191,1273 @@ } }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "name": "check_suite_id", + "description": "The unique identifier of the check suite.
", "in": "path", "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "check_name", + "description": "Returns check runs with the specified name.
The slug values for teams
", - "isRequired": true + "name": "status", + "description": "Returns check runs with the specified status.
Filters check runs by their completed_at timestamp. latest returns the most recent check runs.
The number of 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 + } } ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Example removing a team in a branch protection rule", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "teams": [ - "justice-league" - ] - }, "parameters": { "owner": "OWNER", "repo": "REPO", - "branch": "BRANCH" + "check_suite_id": "CHECK_SUITE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "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" + "example": { + "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" }, - "slug": { - "type": "string" + "name": "mighty_readme", + "check_suite": { + "id": 5 }, - "description": { - "type": [ - "string", - "null" + "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" ] }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { + "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" + } + } + } + ] + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "check_runs" + ], + "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": { - "pull": { - "type": "boolean" + "id": { + "description": "The id of the check.", + "type": "integer", + "examples": [ + 21 + ] }, - "triage": { - "type": "boolean" + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] }, - "push": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] }, - "maintain": { - "type": "boolean" + "external_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "42" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "details_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://example.com" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": [ + "string", + "null" + ] + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "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.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "check_suite": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ] + }, + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" + "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" + ] + } }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, "id": { - "description": "Unique identifier of the team", + "description": "Unique identifier of the deployment", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VGVhbTE=" + "MDEwOkRlcGxveW1lbnQx" ] }, - "url": { - "description": "URL for the team", + "task": { + "description": "Parameter to specify a task to execute", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/1" + "deploy" ] }, - "members_url": { + "original_environment": { "type": "string", "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" + "staging" ] }, - "name": { - "description": "Name of the team", + "environment": { + "description": "Name for the target deployment environment.", "type": "string", "examples": [ - "Justice League" + "production" ] }, "description": { - "description": "Description of the team", "type": [ "string", "null" ], "examples": [ - "A great team." + "Deploy request from hubot" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "admin" + "2012-07-20T01:19:13Z" ] }, - "privacy": { - "description": "The level of privacy this team should have", + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "closed" + "2012-07-20T01:19:13Z" ] }, - "html_url": { + "statuses_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, - "repositories_url": { + "repository_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "https://api.github.com/repos/octocat/example" ] }, - "slug": { - "type": "string", + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "type": "boolean", "examples": [ - "justice-league" + true ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", "examples": [ - "uid=example,ou=users,dc=github,dc=com" + true ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - } - } - } - ], - "previews": [], - "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. |
OK
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "title": "Get users with access to the protected branch", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "title": "Add user access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "users", - "in": "body", - "description": "The username for users
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example adding a user in a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "users": [ - "octocat" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + } + }, + "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" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } } } } ], "previews": [], - "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. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
OK
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "title": "Set user access restrictions", - "category": "branches", - "subcategory": "branch-protection", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", + "title": "List check runs for a Git reference", + "category": "checks", + "subcategory": "runs", "parameters": [ { "name": "owner", @@ -115560,532 +152478,1285 @@ } }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "name": "ref", + "description": "ref parameter
", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "users", - "in": "body", - "description": "The username for users
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ + }, { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example replacing a user in a branch protection rule", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "users": [ - "octocat" - ] - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - } + "name": "check_name", + "description": "Returns check runs with the specified name.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and 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. |
OK
" + "name": "status", + "description": "Returns check runs with the specified status.
Validation failed, or the endpoint has been spammed.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "title": "Remove user access restrictions", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ + "name": "filter", + "description": "Filters check runs by their completed_at timestamp. latest returns the most recent check runs.
The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 1 } }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", - "in": "path", - "required": true, + "name": "app_id", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "integer" }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "users", - "in": "body", - "description": "The username for users
", - "isRequired": true + "description": "" } ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Example removing a user in a branch protection rule", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "users": [ - "octocat" - ] - }, "parameters": { "owner": "OWNER", "repo": "REPO", - "branch": "BRANCH" + "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "example": { + "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" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "name": "mighty_readme", + "check_suite": { + "id": 5 }, - "type": { - "type": "string", - "examples": [ - "User" + "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" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "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" + } + } + } + ] + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "check_runs" + ], + "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.", + "type": "integer", + "examples": [ + 21 + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "external_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "42" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "details_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://example.com" + ] + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "neutral" + ] + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2018-05-04T01:14:52Z" + ] + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": [ + "string", + "null" + ] + }, + "summary": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": [ + "string", + "null" + ] + }, + "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.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "check_suite": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ] + }, + "app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "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" + ] + } + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1" + ] + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkRlcGxveW1lbnQx" + ] + }, + "task": { + "description": "Parameter to specify a task to execute", + "type": "string", + "examples": [ + "deploy" + ] + }, + "original_environment": { + "type": "string", + "examples": [ + "staging" + ] + }, + "environment": { + "description": "Name for the target deployment environment.", + "type": "string", + "examples": [ + "production" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Deploy request from hubot" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2012-07-20T01:19:13Z" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/example/deployments/1/statuses" + ] + }, + "repository_url": { + "type": "string", + "format": "uri", + "examples": [ + "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.", + "type": "boolean", + "examples": [ + true + ] + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "type": "boolean", + "examples": [ + true + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + } + }, + "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" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } } } } ], "previews": [], - "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. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
OK
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" } ] } - ] - }, - "checks": { - "runs": [ + ], + "suites": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-runs", - "title": "Create a check run", + "requestPath": "/repos/{owner}/{repo}/check-suites", + "title": "Create a check suite", "category": "checks", - "subcategory": "runs", + "subcategory": "suites", "parameters": [ { "name": "owner", @@ -116100,236 +153771,31 @@ "name": "repo", "description": "The name of the repository. The name is not case sensitive.
", "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "The name of the check. For example, \"code-coverage\".
", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "in": "body", - "description": "The SHA of the commit.
", - "isRequired": true - }, - { - "type": "string", - "name": "details_url", - "in": "body", - "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.
" - }, - { - "type": "string", - "name": "external_id", - "in": "body", - "description": "A reference for the run on the integrator's system.
" - }, - { - "type": "string", - "name": "status", - "in": "body", - "description": "The current status.
", - "enum": [ - "queued", - "in_progress", - "completed" - ], - "default": "queued" - }, - { - "type": "string", - "name": "started_at", - "in": "body", - "description": "The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
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.
The title of the check run.
", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
", - "isRequired": true - }, - { - "type": "string", - "name": "text", - "description": "The details of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
" - }, - { - "type": "array of objects", - "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run 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\".
", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "The path of the file to add an annotation to. For example, assets/css/main.css.
The start line of the annotation. Line numbers start at 1.
", - "isRequired": true - }, - { - "type": "integer", - "name": "end_line", - "description": "The end line of the annotation.
", - "isRequired": true - }, - { - "type": "integer", - "name": "start_column", - "description": "The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.
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.
The level of the annotation.
", - "isRequired": true, - "enum": [ - "notice", - "warning", - "failure" - ] - }, - { - "type": "string", - "name": "message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.
", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "The title that represents the annotation. The maximum size is 255 characters.
" - }, - { - "type": "string", - "name": "raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.
" - } - ] - }, - { - "type": "array of objects", - "name": "images", - "description": "Adds images to the output displayed in the GitHub pull request UI.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alt", - "description": "The alternative text for the image.
", - "isRequired": true - }, - { - "type": "string", - "name": "image_url", - "description": "The full URL of the image.
", - "isRequired": true - }, - { - "type": "string", - "name": "caption", - "description": "A short image description.
" - } - ] - } - ] - }, + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ { - "type": "array of objects", - "name": "actions", + "type": "string", + "name": "head_sha", "in": "body", - "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. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.
", - "isRequired": true - }, - { - "type": "string", - "name": "identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.
", - "isRequired": true - } - ] + "description": "The sha of the head commit.
", + "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { - "key": "example-of-in-progress-conclusion", + "key": "default", "request": { "contentType": "application/json", - "description": "Example of an in_progress conclusion", + "description": "Example 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "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": "" - } + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" }, "parameters": { "owner": "OWNER", @@ -116337,32 +153803,22 @@ } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", - "description": "Response for in_progress conclusion
", + "description": "Response when the suite already exists
", "example": { - "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": "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 - }, + "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", @@ -116404,100 +153860,298 @@ "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" - } + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 + }, + "head_commit": { + "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "timestamp": "2016-10-10T00:00:00Z", + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com" } - ] + }, + "latest_check_runs_count": 1, + "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" }, "schema": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", + "title": "CheckSuite", + "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "id": { - "description": "The id of the check.", "type": "integer", "examples": [ - 21 - ] - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + 5 ] }, "node_id": { "type": "string", "examples": [ - "MDg6Q2hlY2tSdW40" + "MDEwOkNoZWNrU3VpdGU1" ] }, - "external_id": { + "head_branch": { "type": [ "string", "null" ], "examples": [ - "42" + "master" ] }, - "url": { + "head_sha": { + "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, - "details_url": { + "status": { "type": [ "string", "null" ], - "examples": [ - "https://example.com" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in.", - "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + null ], "examples": [ - "queued" + "completed" ] }, "conclusion": { @@ -116513,89 +154167,138 @@ "skipped", "timed_out", "action_required", + "startup_failure", + "stale", null ], "examples": [ "neutral" ] }, - "started_at": { + "url": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2018-05-04T01:14:52Z" + "https://api.github.com/repos/github/hello-world/check-suites/5" ] }, - "completed_at": { + "before": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2018-05-04T01:14:52Z" - ] - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" + "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, - "name": { - "description": "The name of the check.", - "type": "string", + "after": { + "type": [ + "string", + "null" + ], "examples": [ - "test-coverage" + "d6fde92930d4715a2b49857d24b940956b26d2d3" ] }, - "check_suite": { + "pull_requests": { "type": [ - "object", + "array", "null" ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] + "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" + ] + } }, "app": { "anyOf": [ @@ -116929,616 +154632,917 @@ } ] }, - "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" - ] - } + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "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" - ] - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "ref", - "sha", - "repo" - ] - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "deployment": { - "title": "Deployment", - "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", - "type": "object", - "properties": { - "url": { + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", + "statuses_url": { + "type": "string", "examples": [ - 42 + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "node_id": { + "subscribers_url": { "type": "string", + "format": "uri", "examples": [ - "MDEwOkRlcGxveW1lbnQx" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "task": { - "description": "Parameter to specify a task to execute", + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "deploy" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "original_environment": { + "tags_url": { "type": "string", + "format": "uri", "examples": [ - "staging" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "environment": { - "description": "Name for the target deployment environment.", + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { "type": "string", "examples": [ - "production" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "description": { + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "Deploy request from hubot" + "2011-01-26T19:06:43Z" ] }, "created_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2012-07-20T01:19:13Z" + "2011-01-26T19:01:12Z" ] }, "updated_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2012-07-20T01:19:13Z" + "2011-01-26T19:14:43Z" ] }, - "statuses_url": { + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1/statuses" + "admin" ] }, - "repository_url": { - "type": "string", - "format": "uri", + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/example" + 0 ] }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean", + "open_issues": { + "type": "integer", "examples": [ - true + 0 ] }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { "type": "boolean", "examples": [ - true + false ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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.", + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { + "status": { "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "enum": [ + "enabled", + "disabled" ] - }, - "client_secret": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + "enum": [ + "enabled", + "disabled" ] - }, - "pem": { + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"-----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\"" + "enum": [ + "enabled", + "disabled" ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] + } } - ] + } } }, "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", - "task", - "environment", - "description", + "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", - "repository_url", - "url", - "created_at", - "updated_at" + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "head_commit": { + "title": "Simple Commit", + "description": "A commit.", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + }, + "committer": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" ] + }, + "latest_check_runs_count": { + "type": "integer" + }, + "check_runs_url": { + "type": "string" + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" } }, "required": [ "id", "node_id", - "head_sha", - "name", - "url", - "html_url", - "details_url", + "head_branch", "status", "conclusion", - "started_at", - "completed_at", - "external_id", - "check_suite", - "output", + "head_sha", + "url", + "before", + "after", + "created_at", + "updated_at", "app", + "head_commit", + "repository", + "latest_check_runs_count", + "check_runs_url", "pull_requests" ] } } }, { - "key": "example-of-completed-conclusion", + "key": "default", "request": { "contentType": "application/json", - "description": "Example of a completed conclusion", + "description": "Example 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "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" - } - ] + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" }, "parameters": { "owner": "OWNER", @@ -117548,43 +155552,195 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion
", + "description": "Response when the suite was created
", "example": { - "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", + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", "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 - }, + "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", + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "owner": { + "login": "octocat", "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", + "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", + "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -117592,121 +155748,157 @@ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_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 + "site_admin": false }, - "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", + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" + "admin": false, + "push": false, + "pull": true }, - "events": [ - "push", - "pull_request" - ] + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 }, - "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" - } - } + "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" }, "schema": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", + "title": "CheckSuite", + "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "id": { - "description": "The id of the check.", "type": "integer", "examples": [ - 21 - ] - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + 5 ] }, "node_id": { "type": "string", "examples": [ - "MDg6Q2hlY2tSdW40" + "MDEwOkNoZWNrU3VpdGU1" ] }, - "external_id": { + "head_branch": { "type": [ "string", "null" ], "examples": [ - "42" + "master" ] }, - "url": { + "head_sha": { + "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, - "details_url": { + "status": { "type": [ "string", "null" ], - "examples": [ - "https://example.com" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in.", - "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + null ], "examples": [ - "queued" + "completed" ] }, "conclusion": { @@ -117722,89 +155914,138 @@ "skipped", "timed_out", "action_required", + "startup_failure", + "stale", null ], "examples": [ "neutral" ] }, - "started_at": { + "url": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2018-05-04T01:14:52Z" + "https://api.github.com/repos/github/hello-world/check-suites/5" ] }, - "completed_at": { + "before": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2018-05-04T01:14:52Z" - ] - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" + "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, - "name": { - "description": "The name of the check.", - "type": "string", + "after": { + "type": [ + "string", + "null" + ], "examples": [ - "test-coverage" + "d6fde92930d4715a2b49857d24b940956b26d2d3" ] }, - "check_suite": { + "pull_requests": { "type": [ - "object", + "array", "null" ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] + "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" + ] + } }, "app": { "anyOf": [ @@ -118138,560 +156379,904 @@ } ] }, - "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" - ] - } + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "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" - ] - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "ref", - "sha", - "repo" - ] - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "deployment": { - "title": "Deployment", - "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", - "type": "object", - "properties": { "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 42 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDEwOkRlcGxveW1lbnQx" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "task": { - "description": "Parameter to specify a task to execute", + "blobs_url": { "type": "string", "examples": [ - "deploy" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "original_environment": { + "branches_url": { "type": "string", "examples": [ - "staging" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "environment": { - "description": "Name for the target deployment environment.", + "collaborators_url": { "type": "string", "examples": [ - "production" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] }, - "description": { + "updated_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "Deploy request from hubot" + "2011-01-26T19:14:43Z" ] }, - "created_at": { + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "type": "string", - "format": "date-time", "examples": [ - "2012-07-20T01:19:13Z" + "admin" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2012-07-20T01:19:13Z" + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" ] }, - "statuses_url": { - "type": "string", - "format": "uri", + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1/statuses" + 0 ] }, - "repository_url": { - "type": "string", - "format": "uri", + "open_issues": { + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/example" + 0 ] }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean", + "watchers": { + "type": "integer", "examples": [ - true + 0 ] }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { "type": "boolean", "examples": [ - true + false ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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.", + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { + "status": { "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "enum": [ + "enabled", + "disabled" ] - }, - "client_secret": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + "enum": [ + "enabled", + "disabled" ] - }, - "pem": { + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"-----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\"" + "enum": [ + "enabled", + "disabled" ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] + } } - ] + } } }, "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", - "task", - "environment", - "description", + "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", - "repository_url", - "url", - "created_at", - "updated_at" + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "head_commit": { + "title": "Simple Commit", + "description": "A commit.", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + }, + "committer": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" ] + }, + "latest_check_runs_count": { + "type": "integer" + }, + "check_runs_url": { + "type": "string" + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" } }, "required": [ "id", "node_id", - "head_sha", - "name", - "url", - "html_url", - "details_url", + "head_branch", "status", "conclusion", - "started_at", - "completed_at", - "external_id", - "check_suite", - "output", + "head_sha", + "url", + "before", + "after", + "created_at", + "updated_at", "app", + "head_commit", + "repository", + "latest_check_runs_count", + "check_runs_url", "pull_requests" ] } @@ -118699,21 +157284,25 @@ } ], "previews": [], - "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.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", + "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.
By 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.
Response when the suite already exists
" + }, { "httpStatusCode": "201", - "description": "Created
" + "description": "Response when the suite was created
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "title": "Get a check run", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", + "title": "Update repository preferences for check suites", "category": "checks", - "subcategory": "runs", + "subcategory": "suites", "parameters": [ { "name": "owner", @@ -118732,29 +157321,50 @@ "schema": { "type": "string" } - }, + } + ], + "bodyParameters": [ { - "name": "check_run_id", - "description": "The unique identifier of the check run.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } + "type": "array of objects", + "name": "auto_trigger_checks", + "in": "body", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "app_id", + "description": "The id of the GitHub App.
Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.
Response
", "example": { - "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 + "preferences": { + "auto_trigger_checks": [ + { + "app_id": 2, + "setting": true + }, + { + "app_id": 4, + "setting": false + } + ] }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", "owner": { - "login": "github", + "login": "octocat", "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", + "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", + "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -118804,1114 +157403,1042 @@ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_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 + "site_admin": false }, - "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", + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" + "admin": false, + "push": false, + "pull": true }, - "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" - } + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - }, - "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.", - "type": "integer", - "examples": [ - 21 - ] - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6Q2hlY2tSdW40" - ] - }, - "external_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "42" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" - ] - }, - "details_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://example.com" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ], - "examples": [ - "queued" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ], - "examples": [ - "neutral" - ] - }, - "started_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2018-05-04T01:14:52Z" - ] - }, - "completed_at": { - "type": [ - "string", - "null" + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" ], - "format": "date-time", - "examples": [ - "2018-05-04T01:14:52Z" - ] + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + } + } + }, + "schema": { + "title": "Check Suite Preference", + "description": "Check suite configuration preferences for a repository.", + "type": "object", + "required": [ + "preferences", + "repository" + ], + "properties": { + "preferences": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "integer" + }, + "setting": { + "type": "boolean" + } + }, + "required": [ + "app_id", + "setting" + ] + } + } + } }, - "output": { + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "title": { - "type": [ - "string", - "null" + "id": { + "type": "integer", + "examples": [ + 1296269 ] }, - "summary": { - "type": [ - "string", - "null" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "text": { - "type": [ - "string", - "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" ] }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { + "full_name": { "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" - ] - }, - "name": { - "description": "The name of the check.", - "type": "string", - "examples": [ - "test-coverage" - ] - }, - "check_suite": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] - }, - "app": { - "anyOf": [ - { - "type": "null" + "examples": [ + "octocat/Hello-World" + ] }, - { - "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.", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 + "name": { + "type": [ + "string", + "null" ] }, - "slug": { - "description": "The slug name of the GitHub app", + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "probot-owners" + "octocat" ] }, - "node_id": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + 1 ] }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "name": { - "description": "The name of the GitHub app", + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "Probot Owners" + "https://github.com/images/error/octocat_happy.gif" ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "The description of the app." + "41d064eb2195891e12d0413f63227ea7" ] }, - "external_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://github.com/octocat" ] }, - "created_at": { + "followers_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/followers" ] }, - "updated_at": { + "following_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "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" - } + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, + "starred_url": { + "type": "string", "examples": [ - "label", - "deployment" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", + "subscriptions_url": { + "type": "string", + "format": "uri", "examples": [ - 5 + "https://api.github.com/users/octocat/subscriptions" ] }, - "client_id": { + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "https://api.github.com/users/octocat/orgs" ] }, - "client_secret": { + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + "https://api.github.com/users/octocat/repos" ] }, - "webhook_secret": { - "type": [ - "string", - "null" - ], + "events_url": { + "type": "string", "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "pem": { + "received_events_url": { "type": "string", + "format": "uri", "examples": [ - "\"-----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\"" + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - ] - }, - "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" - ] - } - }, - "deployment": { - "title": "Deployment", - "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", - "type": "object", - "properties": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 42 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDEwOkRlcGxveW1lbnQx" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "task": { - "description": "Parameter to specify a task to execute", + "blobs_url": { "type": "string", "examples": [ - "deploy" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "original_environment": { + "branches_url": { "type": "string", "examples": [ - "staging" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" ] }, - "environment": { - "description": "Name for the target deployment environment.", - "type": "string", - "examples": [ - "production" + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" ] }, - "description": { + "license": { "type": [ - "string", + "object", "null" ], - "examples": [ - "Deploy request from hubot" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2012-07-20T01:19:13Z" - ] + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } }, - "updated_at": { - "type": "string", - "format": "date-time", + "forks": { + "type": "integer", "examples": [ - "2012-07-20T01:19:13Z" + 0 ] }, - "statuses_url": { - "type": "string", - "format": "uri", + "open_issues": { + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1/statuses" + 0 ] }, - "repository_url": { - "type": "string", - "format": "uri", + "watchers": { + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/example" + 0 ] }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean", - "examples": [ - true - ] + "allow_forking": { + "type": "boolean" }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "web_commit_signoff_required": { "type": "boolean", "examples": [ - true + false ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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.", + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { + "status": { "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "enum": [ + "enabled", + "disabled" ] - }, - "client_secret": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + "enum": [ + "enabled", + "disabled" ] - }, - "pem": { + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"-----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\"" + "enum": [ + "enabled", + "disabled" ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] + } } - ] + } } }, "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", - "task", - "environment", - "description", + "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", - "repository_url", - "url", - "created_at", - "updated_at" + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } - }, - "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" - ] + } } } } ], "previews": [], - "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.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -119921,11 +158448,11 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "title": "Update a check run", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "title": "Get a check suite", "category": "checks", - "subcategory": "runs", + "subcategory": "suites", "parameters": [ { "name": "owner", @@ -119946,8 +158473,8 @@ } }, { - "name": "check_run_id", - "description": "The unique identifier of the check run.
", + "name": "check_suite_id", + "description": "The unique identifier of the check suite.
", "in": "path", "required": true, "schema": { @@ -119955,251 +158482,18 @@ } } ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "The name of the check. For example, \"code-coverage\".
" - }, - { - "type": "string", - "name": "details_url", - "in": "body", - "description": "The URL of the integrator's site that has the full details of the check.
" - }, - { - "type": "string", - "name": "external_id", - "in": "body", - "description": "A reference for the run on the integrator's system.
" - }, - { - "type": "string", - "name": "started_at", - "in": "body", - "description": "This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The current status.
", - "enum": [ - "queued", - "in_progress", - "completed" - ] - }, - { - "type": "string", - "name": "conclusion", - "in": "body", - "description": "Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
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.
Required.
" - }, - { - "type": "string", - "name": "summary", - "description": "Can contain Markdown.
", - "isRequired": true - }, - { - "type": "string", - "name": "text", - "description": "Can contain Markdown.
" - }, - { - "type": "array of objects", - "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run 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\".
", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "The path of the file to add an annotation to. For example, assets/css/main.css.
The start line of the annotation. Line numbers start at 1.
", - "isRequired": true - }, - { - "type": "integer", - "name": "end_line", - "description": "The end line of the annotation.
", - "isRequired": true - }, - { - "type": "integer", - "name": "start_column", - "description": "The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.
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.
The level of the annotation.
", - "isRequired": true, - "enum": [ - "notice", - "warning", - "failure" - ] - }, - { - "type": "string", - "name": "message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.
", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "The title that represents the annotation. The maximum size is 255 characters.
" - }, - { - "type": "string", - "name": "raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.
" - } - ] - }, - { - "type": "array of objects", - "name": "images", - "description": "Adds images to the output displayed in the GitHub pull request UI.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alt", - "description": "The alternative text for the image.
", - "isRequired": true - }, - { - "type": "string", - "name": "image_url", - "description": "The full URL of the image.
", - "isRequired": true - }, - { - "type": "string", - "name": "caption", - "description": "A short image description.
" - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "actions", - "in": "body", - "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.\"
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.
", - "isRequired": true - }, - { - "type": "string", - "name": "identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.
", - "isRequired": true - } - ] - } - ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "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" - } - ] - } - }, "parameters": { "owner": "OWNER", "repo": "REPO", - "check_run_id": "CHECK_RUN_ID" + "check_suite_id": "CHECK_SUITE_ID" } }, "response": { @@ -120207,28 +158501,18 @@ "contentType": "application/json", "description": "Response
", "example": { - "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", + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", "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 - }, + "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", @@ -120260,110 +158544,308 @@ "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" + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true }, - "events": [ - "push", - "pull_request" - ] + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 }, - "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" - } - } + "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" }, "schema": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", + "title": "CheckSuite", + "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "id": { - "description": "The id of the check.", "type": "integer", "examples": [ - 21 - ] - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + 5 ] }, "node_id": { "type": "string", "examples": [ - "MDg6Q2hlY2tSdW40" + "MDEwOkNoZWNrU3VpdGU1" ] }, - "external_id": { + "head_branch": { "type": [ "string", "null" ], "examples": [ - "42" + "master" ] }, - "url": { + "head_sha": { + "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, - "details_url": { + "status": { "type": [ "string", "null" ], - "examples": [ - "https://example.com" - ] - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in.", - "type": "string", "enum": [ "queued", "in_progress", - "completed" + "completed", + null ], "examples": [ - "queued" + "completed" ] }, "conclusion": { @@ -120379,89 +158861,138 @@ "skipped", "timed_out", "action_required", + "startup_failure", + "stale", null ], "examples": [ "neutral" ] }, - "started_at": { + "url": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2018-05-04T01:14:52Z" + "https://api.github.com/repos/github/hello-world/check-suites/5" ] }, - "completed_at": { + "before": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2018-05-04T01:14:52Z" - ] - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" + "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, - "name": { - "description": "The name of the check.", - "type": "string", + "after": { + "type": [ + "string", + "null" + ], "examples": [ - "test-coverage" + "d6fde92930d4715a2b49857d24b940956b26d2d3" ] }, - "check_suite": { + "pull_requests": { "type": [ - "object", + "array", "null" ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] + "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" + ] + } }, "app": { "anyOf": [ @@ -120795,560 +159326,904 @@ } ] }, - "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" - ] - } + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "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" - ] - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "ref", - "sha", - "repo" - ] - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "deployment": { - "title": "Deployment", - "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", - "type": "object", - "properties": { "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 42 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDEwOkRlcGxveW1lbnQx" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "task": { - "description": "Parameter to specify a task to execute", + "blobs_url": { "type": "string", "examples": [ - "deploy" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "original_environment": { + "branches_url": { "type": "string", "examples": [ - "staging" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "environment": { - "description": "Name for the target deployment environment.", + "collaborators_url": { "type": "string", "examples": [ - "production" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "description": { + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "Deploy request from hubot" + "2011-01-26T19:06:43Z" ] }, "created_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2012-07-20T01:19:13Z" + "2011-01-26T19:01:12Z" ] }, "updated_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2012-07-20T01:19:13Z" + "2011-01-26T19:14:43Z" ] }, - "statuses_url": { + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1/statuses" + "admin" ] }, - "repository_url": { - "type": "string", - "format": "uri", + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/example" + 0 ] }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean", + "watchers": { + "type": "integer", "examples": [ - true + 0 ] }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { "type": "boolean", "examples": [ - true + false ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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.", + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { + "status": { "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "enum": [ + "enabled", + "disabled" ] - }, - "client_secret": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + "enum": [ + "enabled", + "disabled" ] - }, - "pem": { + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"-----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\"" + "enum": [ + "enabled", + "disabled" ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] + } } - ] + } } }, "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", - "task", - "environment", - "description", + "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", - "repository_url", - "url", - "created_at", - "updated_at" + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "head_commit": { + "title": "Simple Commit", + "description": "A commit.", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + }, + "committer": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" ] + }, + "latest_check_runs_count": { + "type": "integer" + }, + "check_runs_url": { + "type": "string" + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" } }, "required": [ "id", "node_id", - "head_sha", - "name", - "url", - "html_url", - "details_url", + "head_branch", "status", "conclusion", - "started_at", - "completed_at", - "external_id", - "check_suite", - "output", + "head_sha", + "url", + "before", + "after", + "created_at", + "updated_at", "app", + "head_commit", + "repository", + "latest_check_runs_count", + "check_runs_url", "pull_requests" ] } @@ -121356,202 +160231,7 @@ } ], "previews": [], - "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.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "title": "List check run annotations", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_run_id", - "description": "The unique identifier of the check run.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of 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 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_run_id": "CHECK_RUN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Check Annotation", - "description": "Check Annotation", - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": [ - "README.md" - ] - }, - "start_line": { - "type": "integer", - "examples": [ - 2 - ] - }, - "end_line": { - "type": "integer", - "examples": [ - 2 - ] - }, - "start_column": { - "type": [ - "integer", - "null" - ], - "examples": [ - 5 - ] - }, - "end_column": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10 - ] - }, - "annotation_level": { - "type": [ - "string", - "null" - ], - "examples": [ - "warning" - ] - }, - "title": { - "type": [ - "string", - "null" - ], - "examples": [ - "Spell Checker" - ] - }, - "message": { - "type": [ - "string", - "null" - ], - "examples": [ - "Check your spelling for 'banaas'." - ] - }, - "raw_details": { - "type": [ - "string", - "null" - ], - "examples": [ - "Do you mean 'bananas' or 'banana'?" - ] - }, - "blob_href": { - "type": "string" - } - }, - "required": [ - "path", - "blob_href", - "start_line", - "end_line", - "start_column", - "end_column", - "annotation_level", - "title", - "message", - "raw_details" - ] - } - } - } - } - ], - "previews": [], - "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.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
The unique identifier of the check run.
", + "name": "check_suite_id", + "description": "The unique identifier of the check suite.
", "in": "path", "required": true, "schema": { @@ -121606,7 +160286,7 @@ "parameters": { "owner": "OWNER", "repo": "REPO", - "check_run_id": "CHECK_RUN_ID" + "check_suite_id": "CHECK_SUITE_ID" } }, "response": { @@ -121624,36 +160304,22 @@ } } ], - "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared.
To rerequest a check run, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
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.
To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
Created
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation error if the check run is not rerequestable
" } - ], - "previews": [ - "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:
application/vnd.github.antiope-preview+jsonThe unique identifier of the check suite.
", + "name": "ref", + "description": "ref parameter
", "in": "path", "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "check_name", - "description": "Returns check runs with the specified name.
Returns check runs with the specified status.
Filters check suites by GitHub App id.
Filters check runs by their completed_at timestamp. latest returns the most recent check runs.
Returns check runs with the specified name.
Response
", "example": { "total_count": 1, - "check_runs": [ + "check_suites": [ { - "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", + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", "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 - }, + "url": "https://api.github.com/repos/github/hello-world/check-suites/5", + "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "pull_requests": [], "app": { "id": 1, "slug": "octoapp", @@ -121823,31 +160460,131 @@ "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" - } - } + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 + }, + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "head_commit": { + "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "timestamp": "2016-10-10T00:00:00Z", + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com" } - ] + }, + "latest_check_runs_count": 1, + "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" } ] }, @@ -121855,82 +160592,60 @@ "type": "object", "required": [ "total_count", - "check_runs" + "check_suites" ], "properties": { "total_count": { "type": "integer" }, - "check_runs": { + "check_suites": { "type": "array", "items": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", + "title": "CheckSuite", + "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "id": { - "description": "The id of the check.", "type": "integer", "examples": [ - 21 - ] - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + 5 ] }, "node_id": { "type": "string", "examples": [ - "MDg6Q2hlY2tSdW40" + "MDEwOkNoZWNrU3VpdGU1" ] }, - "external_id": { + "head_branch": { "type": [ "string", "null" ], "examples": [ - "42" + "master" ] }, - "url": { + "head_sha": { + "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" - ] - }, - "details_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://example.com" + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" ] }, "status": { - "description": "The phase of the lifecycle that the check is currently in.", - "type": "string", + "type": [ + "string", + "null" + ], "enum": [ "queued", "in_progress", - "completed" + "completed", + null ], "examples": [ - "queued" + "completed" ] }, "conclusion": { @@ -121946,89 +160661,138 @@ "skipped", "timed_out", "action_required", + "startup_failure", + "stale", null ], "examples": [ "neutral" ] }, - "started_at": { + "url": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2018-05-04T01:14:52Z" + "https://api.github.com/repos/github/hello-world/check-suites/5" ] }, - "completed_at": { + "before": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2018-05-04T01:14:52Z" - ] - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": [ - "string", - "null" - ] - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "text": { - "type": [ - "string", - "null" - ] - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" + "146e867f55c26428e5f9fade55a9bbf5e95a7912" ] }, - "name": { - "description": "The name of the check.", - "type": "string", + "after": { + "type": [ + "string", + "null" + ], "examples": [ - "test-coverage" + "d6fde92930d4715a2b49857d24b940956b26d2d3" ] }, - "check_suite": { + "pull_requests": { "type": [ - "object", + "array", "null" ], - "properties": { - "id": { - "type": "integer" - } - }, - "required": [ - "id" - ] + "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" + ] + } }, "app": { "anyOf": [ @@ -122339,1911 +161103,2364 @@ "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, - "pem": { - "type": "string", - "examples": [ - "\"-----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\"" - ] + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + } + }, + "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", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "head_commit": { + "title": "Simple Commit", + "description": "A commit.", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + }, + "committer": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" } }, "required": [ - "id", - "node_id", - "owner", "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "email" ] } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" ] }, - "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" - ] - } + "latest_check_runs_count": { + "type": "integer" }, - "deployment": { - "title": "Deployment", - "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "check_runs_url": { + "type": "string" + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + } + }, + "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" + ] + } + } + } + } + } + } + ], + "previews": [], + "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.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
OK
" + } + ] + } + ] + }, + "code-scanning": { + "code-scanning": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/code-scanning/alerts", + "title": "List code scanning alerts for an enterprise", + "category": "code-scanning", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", + "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}", + "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}", + "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": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", + "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}", + "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}", + "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": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1" + "name": { + "type": [ + "string", + "null" ] }, - "id": { - "description": "Unique identifier of the deployment", - "type": "integer", - "examples": [ - 42 + "email": { + "type": [ + "string", + "null" ] }, - "node_id": { + "login": { "type": "string", "examples": [ - "MDEwOkRlcGxveW1lbnQx" + "octocat" ] }, - "task": { - "description": "Parameter to specify a task to execute", - "type": "string", + "id": { + "type": "integer", "examples": [ - "deploy" + 1 ] }, - "original_environment": { + "node_id": { "type": "string", "examples": [ - "staging" + "MDQ6VXNlcjE=" ] }, - "environment": { - "description": "Name for the target deployment environment.", + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "production" + "https://github.com/images/error/octocat_happy.gif" ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "Deploy request from hubot" + "41d064eb2195891e12d0413f63227ea7" ] }, - "created_at": { + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2012-07-20T01:19:13Z" + "https://api.github.com/users/octocat" ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2012-07-20T01:19:13Z" + "https://github.com/octocat" ] }, - "statuses_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/example/deployments/1/statuses" + "https://api.github.com/users/octocat/followers" ] }, - "repository_url": { + "following_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/example" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "type": "boolean", + "gists_url": { + "type": "string", "examples": [ - true + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "type": "boolean", + "starred_url": { + "type": "string", "examples": [ - true + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "task", - "environment", - "description", - "statuses_url", - "repository_url", - "url", - "created_at", - "updated_at" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - }, - "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" ] - } - } - } - } - } - } - ], - "previews": [], - "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.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "title": "List check runs for a Git reference", - "category": "checks", - "subcategory": "runs", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ref", - "description": "ref parameter
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - }, - { - "name": "check_name", - "description": "Returns check runs with the specified name.
Returns check runs with the specified status.
Filters check runs by their completed_at timestamp. latest returns the most recent check runs.
The number of 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": "app_id", - "in": "query", - "required": false, - "schema": { - "type": "integer" - }, - "description": "" - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "ref": "REF" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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 + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "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" + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "enum": [ + null, + "false positive", + "won't fix", + "used in tests" ] }, - "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" - } - } - } - ] - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "check_runs" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "check_runs": { - "type": "array", - "items": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "rule": { "type": "object", "properties": { "id": { - "description": "The id of the check.", - "type": "integer", - "examples": [ - 21 - ] - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6Q2hlY2tSdW40" - ] - }, - "external_id": { "type": [ "string", "null" ], - "examples": [ - "42" - ] + "description": "A unique identifier for the rule used to detect the alert." }, - "url": { + "name": { "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] + "description": "The name of the rule used to detect the alert." }, - "html_url": { + "severity": { "type": [ "string", "null" ], - "examples": [ - "https://github.com/github/hello-world/runs/4" + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error", + null ] }, - "details_url": { + "security_severity_level": { "type": [ "string", "null" ], - "examples": [ - "https://example.com" + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical", + null ] }, - "status": { - "description": "The phase of the lifecycle that the check is currently in.", + "description": { "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" ], - "examples": [ - "queued" - ] + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } }, - "conclusion": { + "help": { "type": [ "string", "null" ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" ], - "examples": [ - "neutral" - ] + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." }, - "started_at": { + "version": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2018-05-04T01:14:52Z" - ] + "description": "The version of the tool used to generate the code scanning analysis." }, - "completed_at": { + "guid": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2018-05-04T01:14:52Z" + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"
\nTo use this endpoint, you must be a member of the enterprise,\nand you must use an access token with the repo scope or security_events scope.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" } - ] - } - ], - "suites": [ + ], + "subcategory": "code-scanning" + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites", - "title": "Create a check suite", - "category": "checks", - "subcategory": "suites", + "verb": "get", + "requestPath": "/orgs/{org}/code-scanning/alerts", + "title": "List code scanning alerts for an organization", + "category": "code-scanning", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -124251,108 +163468,196 @@ } }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, "schema": { "type": "string" } - } - ], - "bodyParameters": [ + }, { - "type": "string", - "name": "head_sha", - "in": "body", - "description": "The sha of the head commit.
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 200", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response when the suite already exists
", - "example": { - "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": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" }, - "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" + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" }, - "events": [ - "push", - "pull_request" - ] - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "template_repository": { + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", + "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", + "name": "Hello-World", + "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, @@ -124374,103 +163679,55 @@ "site_admin": false }, "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", + "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "owner": { + "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}", + "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}", + "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": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -124490,1675 +163747,1348 @@ "type": "User", "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0 - }, - "head_commit": { - "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", - "timestamp": "2016-10-10T00:00:00Z", - "author": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - }, - "committer": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - } - }, - "latest_check_runs_count": 1, - "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" - }, - "schema": { - "title": "CheckSuite", - "description": "A suite of checks performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 5 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "examples": [ - "master" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "status": { - "type": [ - "string", - "null" - ], - "enum": [ - "queued", - "in_progress", - "completed", - null - ], - "examples": [ - "completed" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "startup_failure", - "stale", - null - ], - "examples": [ - "neutral" - ] - }, - "url": { - "type": [ - "string", - "null" + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" ], - "examples": [ - "https://api.github.com/repos/github/hello-world/check-suites/5" - ] + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" }, - "before": { - "type": [ - "string", - "null" - ], - "examples": [ - "146e867f55c26428e5f9fade55a9bbf5e95a7912" - ] + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" }, - "after": { - "type": [ - "string", - "null" - ], - "examples": [ - "d6fde92930d4715a2b49857d24b940956b26d2d3" - ] + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] }, - "pull_requests": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", + "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}", + "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}", + "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": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "head": { + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "ref": { - "type": "string" + "name": { + "type": [ + "string", + "null" + ] }, - "sha": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" + "login": { + "type": "string", + "examples": [ + "octocat" ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" }, - "sha": { - "type": "string" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "pem": { - "type": "string", - "examples": [ - "\"-----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": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "enum": [ + null, + "false positive", + "won't fix", + "used in tests" + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the rule used to detect the alert." }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error", + null + ] }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { + "security_severity_level": { + "type": [ + "string", + "null" + ], + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical", + null + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { "type": "string" } + }, + "help": { + "type": [ + "string", + "null" + ], + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "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", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "head_commit": { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "tree_id": { - "type": "string" - }, - "message": { - "type": "string" - }, - "timestamp": { - "type": "string", - "format": "date-time" - }, - "author": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "type": [ + "string", + "null" + ], + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "type": [ + "string", + "null" + ], + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"
\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo scope or security_events scope.
For public repositories, you may instead use the public_repo scope.
GitHub Apps must have the security_events read permission to use this endpoint.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "subcategory": "code-scanning" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", + "title": "List code scanning alerts for a repository", + "category": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + } }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" - }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", - "description": "Response when the suite was created
", - "example": { - "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 + "description": "Response
", + "example": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "fixed_at": null, + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" }, - "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" + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" }, - "events": [ - "push", - "pull_request" - ] - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] }, - "owner": { + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances" + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -126178,661 +165108,688 @@ "type": "User", "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0 - }, - "head_commit": { - "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", - "timestamp": "2016-10-10T00:00:00Z", - "author": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - }, - "committer": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - } - }, - "latest_check_runs_count": 1, - "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" - }, - "schema": { - "title": "CheckSuite", - "description": "A suite of checks performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 5 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "examples": [ - "master" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "status": { - "type": [ - "string", - "null" - ], - "enum": [ - "queued", - "in_progress", - "completed", - null - ], - "examples": [ - "completed" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "startup_failure", - "stale", - null - ], - "examples": [ - "neutral" - ] - }, - "url": { - "type": [ - "string", - "null" + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" ], - "examples": [ - "https://api.github.com/repos/github/hello-world/check-suites/5" - ] + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" }, - "before": { - "type": [ - "string", - "null" - ], - "examples": [ - "146e867f55c26428e5f9fade55a9bbf5e95a7912" - ] + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" }, - "after": { - "type": [ - "string", - "null" - ], - "examples": [ - "d6fde92930d4715a2b49857d24b940956b26d2d3" - ] + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] }, - "pull_requests": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances" + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "enum": [ + null, + "false positive", + "won't fix", + "used in tests" + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "rule": { "type": "object", "properties": { "id": { - "type": "integer" + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the rule used to detect the alert." }, - "number": { - "type": "integer" + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." }, - "url": { + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "type": [ + "string", + "null" + ], + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "type": [ + "string", + "null" + ], + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/Lists code scanning alerts.
\nTo use this endpoint, you must use an access token with the security_events scope or, for alerts from public repositories only, an access token with the public_repo scope.
GitHub Apps must have the security_events read\npermission to use this endpoint.
The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used ref in the request).
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "subcategory": "code-scanning" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "title": "Get a code scanning alert", + "category": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Response
", + "example": { + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 54933897, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "security_severity_level": "high", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + }, + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" ] }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -126992,682 +165949,1475 @@ "type", "url" ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { + } + ] + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "enum": [ + null, + "false positive", + "won't fix", + "used in tests" + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { "type": [ "string", "null" ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] + "description": "A unique identifier for the rule used to detect the alert." }, - "branches_url": { + "name": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] + "description": "The name of the rule used to detect the alert." }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error", + null ] }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "security_severity_level": { + "type": [ + "string", + "null" + ], + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical", + null ] }, - "commits_url": { + "description": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] + "description": "A short description of the rule used to detect the alert." }, - "compare_url": { + "full_description": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] + "description": "description of the rule used to detect the alert." }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] + "help": { + "type": [ + "string", + "null" + ], + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." }, - "deployments_url": { + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] + "description": "The name of the tool used to generate the code scanning analysis." }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] + "version": { + "type": [ + "string", + "null" + ], + "description": "The version of the tool used to generate the code scanning analysis." }, - "events_url": { + "guid": { + "type": [ + "string", + "null" + ], + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] + "description": "The full Git reference, formatted as `refs/heads/Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "subcategory": "code-scanning" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "title": "Update a code scanning alert", + "category": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.
Required when the state is dismissed. The reason for dismissing or closing the alert.
", + "enum": [ + null, + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "in": "body", + "description": "The dismissal comment associated with the dismissal of the alert.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "state": "dismissed", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library." + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "alert_number": "ALERT_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "number": 42, + "created_at": "2020-08-25T21:28:36Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-09-02T22:34:56Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "security_severity_level": "high", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + }, + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { + } + ] + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "enum": [ + null, + "false positive", + "won't fix", + "used in tests" + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { "type": [ "string", "null" - ] + ], + "description": "A unique identifier for the rule used to detect the alert." }, - "hooks_url": { + "name": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" + "description": "The name of the rule used to detect the alert." }, - "homepage": { + "severity": { "type": [ "string", "null" + ], + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error", + null ] }, - "language": { + "security_severity_level": { "type": [ "string", "null" + ], + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical", + null ] }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." }, - "is_template": { - "type": "boolean" + "full_description": { + "type": "string", + "description": "description of the rule used to detect the alert." }, - "topics": { - "type": "array", + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", "items": { "type": "string" } }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" + "help": { + "type": [ + "string", + "null" + ], + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." }, - "pushed_at": { + "help_uri": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." }, - "created_at": { + "version": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "description": "The version of the tool used to generate the code scanning analysis." }, - "updated_at": { + "guid": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "subcategory": "code-scanning" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + "title": "List instances of a code scanning alert", + "category": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Response
", + "example": [ + { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "state": "open", + "fixed_at": null, + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "classifications": [ + "library" + ] + }, + { + "ref": "refs/pull/3740/merge", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "state": "fixed", + "fixed_at": "2020-02-14T12:29:18Z", + "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", + "message": { + "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." }, - "head_commit": { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "tree_id": { - "type": "string" - }, - "message": { - "type": "string" - }, - "timestamp": { - "type": "string", - "format": "date-time" - }, - "author": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } + "location": { + "path": "app/script.js", + "start_line": 2, + "end_line": 2, + "start_column": 10, + "end_column": 50 + }, + "classifications": [ + "source" + ] + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "subcategory": "code-scanning" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", + "title": "List code scanning analyses for a repository", + "category": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "in": "query", + "description": "The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Filter analyses belonging to the same SARIF upload.
", + "required": false, + "schema": { + "type": "string", + "description": "An identifier for the upload.", + "examples": [ + "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" + ] + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "ref": "refs/heads/main", + "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "environment": "{\"language\":\"python\"}", + "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", + "created_at": "2020-08-27T15:05:21Z", + "results_count": 17, + "rules_count": 49, + "id": 201, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", + "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "deletable": true, + "warning": "" + }, + { + "ref": "refs/heads/my-branch", + "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", + "analysis_key": ".github/workflows/shiftleft.yml:build", + "environment": "{}", + "error": "", + "category": ".github/workflows/shiftleft.yml:build/", + "created_at": "2020-08-31T22:46:44Z", + "results_count": 17, + "rules_count": 32, + "id": 200, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200", + "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582", + "tool": { + "name": "Python Security Analysis", + "guid": null, + "version": "1.2.0" + }, + "deletable": true, + "warning": "" + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. 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.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
You must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
Response when the suite already exists
" + "description": "OK
" }, { - "httpStatusCode": "201", - "description": "Response when the suite was created
" + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" } - ] + ], + "subcategory": "code-scanning" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", - "title": "Update repository preferences for check suites", - "category": "checks", - "subcategory": "suites", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", + "title": "Get a code scanning analysis for a repository", + "category": "code-scanning", "parameters": [ { "name": "owner", @@ -127686,1079 +167436,1199 @@ "schema": { "type": "string" } - } - ], - "bodyParameters": [ + }, { - "type": "array of objects", - "name": "auto_trigger_checks", - "in": "body", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "app_id", - "description": "The id of the GitHub App.
Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.
The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
Response
", + "description": "application/json response
", "example": { - "preferences": { - "auto_trigger_checks": [ - { - "app_id": 2, - "setting": true - }, - { - "app_id": 4, - "setting": false - } - ] + "ref": "refs/heads/main", + "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "environment": "{\"language\":\"javascript\"}", + "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", + "created_at": "2021-01-13T11:55:49Z", + "results_count": 3, + "rules_count": 67, + "id": 3602840, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", + "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6", + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" }, - "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": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - } - } + "deletable": true, + "warning": "" }, "schema": { - "title": "Check Suite Preference", - "description": "Check suite configuration preferences for a repository.", "type": "object", - "required": [ - "preferences", - "repository" - ], "properties": { - "preferences": { - "type": "object", - "properties": { - "auto_trigger_checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer" - }, - "setting": { - "type": "boolean" - } - }, - "required": [ - "app_id", - "setting" - ] - } - } - } + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/application/json+sarif response
", + "example": { + "runs": [ + { + "tool": { + "driver": { + "name": "CodeQL", + "organization": "GitHub", + "semanticVersion": "1.0.0", + "rules": [ + { + "id": "js/unused-local-variable", + "name": "js/unused-local-variable" + } ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" + } + }, + "results": [ + { + "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38", + "message": { + "text": "Unused variable foo." + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "file1.js" + }, + "region": { + "startLine": 1 + } + } } - } - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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" - ] + ], + "ruleId": "js/unused-local-variable", + "properties": [ + { + "github/alertNumber": 2 }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + { + "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2" } + ] + } + ] + } + ] + }, + "schema": { + "type": "object", + "additionalProperties": true + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.
\nThe rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "subcategory": "code-scanning" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", + "title": "Delete a code scanning analysis from a repository", + "category": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "analysis_id", + "in": "path", + "description": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to true, you'll get a 400 response with the message: Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.
Default response
", + "example": { + "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", + "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" + }, + "schema": { + "title": "Analysis deletion", + "description": "Successful deletion of a code scanning analysis", + "type": "object", + "properties": { + "next_analysis_url": { + "type": [ + "string", + "null" + ], + "description": "Next deletable analysis in chain, without last analysis deletion confirmation", + "format": "uri", + "readOnly": true + }, + "confirm_delete_url": { + "type": [ + "string", + "null" + ], + "description": "Next deletable analysis in chain, with last analysis deletion confirmation", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "next_analysis_url", + "confirm_delete_url" + ] + } + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "descriptionHTML": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.
You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.
\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:
\n\"deletable\": true\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:
\nreftoolcategoryIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:
\nAnalysis specified is not deletable.\nThe response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.
As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:
\nOuter loop:
\nList the analyses for the repository, filtered by tool.
\nParse this list to find a deletable analysis. If found:
\nInner loop:
\nconfirm_delete_url and, if found, use this in the next iteration.The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "commit_sha", + "in": "body", + "description": "The SHA of the commit to which the analysis you are uploading relates.
", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.
A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"
The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
" + }, + { + "type": "string", + "name": "started_at", + "in": "body", + "description": "The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.
Default response
", + "example": { + "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "An identifier for the upload.", + "examples": [ + "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" + ] + }, + "url": { + "type": "string", + "description": "The REST API URL for checking the status of the upload.", + "format": "uri", + "readOnly": true + } + } + } + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request if the sarif field is invalid
" + }, + { + "httpStatusCode": "403", + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "413", + "description": "Payload Too Large if the sarif field is too large
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.
There are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 15 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sarif_id", + "description": "The SARIF ID obtained after uploading.
", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "sarif_id": "SARIF_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Default response
", + "example": { + "processing_status": "complete", + "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" + }, + "schema": { + "type": "object", + "properties": { + "processing_status": { + "type": "string", + "enum": [ + "pending", + "complete", + "failed" + ], + "description": "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed." + }, + "analyses_url": { + "type": [ + "string", + "null" + ], + "description": "The REST API URL for getting the analyses associated with the upload.", + "format": "uri", + "readOnly": true + }, + "errors": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Any errors that ocurred during processing of the delivery.", + "readOnly": true + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Not Found if the sarif id does not match any upload
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "subcategory": "code-scanning" + } + ] + }, + "codes-of-conduct": { + "codes-of-conduct": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/codes_of_conduct", + "title": "Get all codes of conduct", + "category": "codes-of-conduct", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "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/" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + } + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + } + ], + "subcategory": "codes-of-conduct" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/codes_of_conduct/{key}", + "title": "Get a code of conduct", + "category": "codes-of-conduct", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "" + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "key": "KEY" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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/" + }, + "schema": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "subcategory": "codes-of-conduct" + } + ] + }, + "collaborators": { + "collaborators": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators", + "title": "List repository collaborators", + "category": "collaborators", + "subcategory": "collaborators", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "affiliation", + "description": "Filter collaborators returned by their affiliation. outside means all outside collaborators of an organization-owned repository. direct means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. all means all collaborators the authenticated user can see.
Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + } + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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, + "triage": true, + "push": true, + "maintain": false, + "admin": false + }, + "role_name": "write" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Collaborator", + "description": "Collaborator", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" } }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - } + "required": [ + "pull", + "push", + "admin" + ] }, - "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" - ] - } + "role_name": { + "type": "string", + "examples": [ + "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" + ] } } } } ], "previews": [], - "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.
", + "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.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
\nTeam members will include the members of child teams.
\nYou must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "title": "Get a check suite", - "category": "checks", - "subcategory": "suites", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", + "title": "Check if a user is a repository collaborator", + "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -128779,12 +168649,12 @@ } }, { - "name": "check_suite_id", - "description": "The unique identifier of the check suite.
", + "name": "username", + "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -128799,837 +168669,221 @@ "parameters": { "owner": "OWNER", "repo": "REPO", - "check_suite_id": "CHECK_SUITE_ID" + "username": "USERNAME" } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "id": 5, - "node_id": "MDEwOkNoZWNrU3VpdGU1", - "head_branch": "master", - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", - "status": "completed", - "conclusion": "neutral", - "url": "https://api.github.com/repos/github/hello-world/check-suites/5", - "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", - "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", - "pull_requests": [], - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0 - }, - "head_commit": { - "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", - "timestamp": "2016-10-10T00:00:00Z", - "author": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - }, - "committer": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - } - }, - "latest_check_runs_count": 1, - "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" - }, - "schema": { - "title": "CheckSuite", - "description": "A suite of checks performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 5 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "examples": [ - "master" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "status": { - "type": [ - "string", - "null" - ], - "enum": [ - "queued", - "in_progress", - "completed", - null - ], - "examples": [ - "completed" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "startup_failure", - "stale", - null - ], - "examples": [ - "neutral" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://api.github.com/repos/github/hello-world/check-suites/5" - ] - }, - "before": { - "type": [ - "string", - "null" - ], - "examples": [ - "146e867f55c26428e5f9fade55a9bbf5e95a7912" - ] - }, - "after": { - "type": [ - "string", - "null" - ], - "examples": [ - "d6fde92930d4715a2b49857d24b940956b26d2d3" - ] - }, - "pull_requests": { - "type": [ - "array", - "null" - ], - "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" - ] - } - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } + }, + "response": { + "statusCode": "204", + "description": "Response if user is a collaborator
" + } + } + ], + "previews": [], + "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.
\nYou must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.
Response if user is a collaborator
" + }, + { + "httpStatusCode": "404", + "description": "Not Found if user is not a collaborator
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", + "title": "Add a repository collaborator", + "category": "collaborators", + "subcategory": "collaborators", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "permission", + "in": "body", + "description": "The permission to grant the collaborator. Only valid on organization-owned repositories.
", + "default": "push" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "new-invitation-is-created", + "request": { + "contentType": "application/json", + "description": "Add a collaborator with triage permissions", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "triage" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response when a new invitation is created
", + "example": { + "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" + }, + "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.", + "type": "integer", + "examples": [ + 42 ] }, "repository": { @@ -130153,6 +169407,9 @@ "has_downloads": { "type": "boolean" }, + "has_discussions": { + "type": "boolean" + }, "archived": { "type": "boolean" }, @@ -130212,6 +169469,12 @@ } } }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, "temp_clone_token": { "type": "string" }, @@ -130312,6 +169575,56 @@ }, "allow_forking": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } } }, "required": [ @@ -130363,210 +169676,802 @@ "url" ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "head_commit": { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "tree_id": { - "type": "string" - }, - "message": { - "type": "string" - }, - "timestamp": { - "type": "string", - "format": "date-time" + "invitee": { + "anyOf": [ + { + "type": "null" }, - "author": { - "type": [ - "object", - "null" - ], + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { "name": { - "type": "string" + "type": [ + "string", + "null" + ] }, "email": { - "type": "string" + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "name", - "email" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "inviter": { + "anyOf": [ + { + "type": "null" }, - "committer": { - "type": [ - "object", - "null" - ], + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { "name": { - "type": "string" + "type": [ + "string", + "null" + ] }, "email": { - "type": "string" + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "permissions": { + "description": "The permission associated with the invitation.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" + ], + "examples": [ + "read" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-06-13T14:52:50-05:00" + ] + }, + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" + }, + "url": { + "description": "URL for the repository invitation", + "type": "string", + "examples": [ + "https://api.github.com/user/repository-invitations/1" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World/invitations" + ] + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", + "url", + "html_url", + "created_at" + ] + } + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Response when a new invitation is created
" + }, + { + "httpStatusCode": "204", + "description": "Response when:
\nForbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\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.\"
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.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou 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.
" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", + "title": "Remove a repository collaborator", + "category": "collaborators", + "subcategory": "collaborators", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", + "title": "Get repository permissions for a user", + "category": "collaborators", + "subcategory": "collaborators", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "if user has admin permissions
", + "example": { + "permission": "admin", + "role_name": "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 + } + }, + "schema": { + "title": "Repository Collaborator Permission", + "description": "Repository Collaborator Permission", + "type": "object", + "properties": { + "permission": { + "type": "string" + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Collaborator", + "description": "Collaborator", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] } }, "required": [ - "name", - "email" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" ] - }, - "latest_check_runs_count": { - "type": "integer" - }, - "check_runs_url": { - "type": "string" - }, - "rerequestable": { - "type": "boolean" - }, - "runs_rerequestable": { - "type": "boolean" } }, "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" + "permission", + "role_name", + "user" ] } } } ], "previews": [], - "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.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "title": "Rerequest a check suite", - "category": "checks", - "subcategory": "suites", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "description": "if user has admin permissions
" }, { - "name": "check_suite_id", - "description": "The unique identifier of the check suite.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "check_suite_id": "CHECK_SUITE_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "previews": [], - "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.
To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
Created
" + "httpStatusCode": "404", + "description": "Resource not found
" } ] - }, + } + ], + "invitations": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "title": "List check suites for a Git reference", - "category": "checks", - "subcategory": "suites", + "requestPath": "/repos/{owner}/{repo}/invitations", + "title": "List repository invitations", + "category": "collaborators", + "subcategory": "invitations", "parameters": [ { "name": "owner", @@ -130586,35 +170491,6 @@ "type": "string" } }, - { - "name": "ref", - "description": "ref parameter
", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - }, - { - "name": "app_id", - "description": "Filters check suites by GitHub App id.
Returns check runs with the specified name.
The number of results per page (max 100).
", @@ -130644,1854 +170520,1105 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO", - "ref": "REF" + "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": { - "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": { + "example": [ + { + "id": 1, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", "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" + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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=" + } + ], + "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.", + "type": "integer", + "examples": [ + 42 ] }, "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0 - }, - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "head_commit": { - "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", - "timestamp": "2016-10-10T00:00:00Z", - "author": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - }, - "committer": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - } - }, - "latest_check_runs_count": 1, - "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "check_suites" - ], - "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", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "examples": [ - 5 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "examples": [ - "master" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "status": { - "type": [ - "string", - "null" - ], - "enum": [ - "queued", - "in_progress", - "completed", - null - ], - "examples": [ - "completed" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - "startup_failure", - "stale", - null - ], - "examples": [ - "neutral" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://api.github.com/repos/github/hello-world/check-suites/5" - ] - }, - "before": { - "type": [ - "string", - "null" - ], - "examples": [ - "146e867f55c26428e5f9fade55a9bbf5e95a7912" - ] - }, - "after": { - "type": [ - "string", - "null" - ], - "examples": [ - "d6fde92930d4715a2b49857d24b940956b26d2d3" + 1296269 ] }, - "pull_requests": { - "type": [ - "array", - "null" - ], - "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" - ] - } - }, - "app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 + "name": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "email": { + "type": [ + "string", + "null" ] }, - "name": { + "login": { "type": "string", "examples": [ - "Hello-World" + "octocat" ] }, - "full_name": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "octocat/Hello-World" + 1 ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "private": { - "type": "boolean" - }, - "html_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "https://github.com/images/error/octocat_happy.gif" ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "This your first repo!" + "41d064eb2195891e12d0413f63227ea7" ] }, - "fork": { - "type": "boolean" - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/users/octocat" ] }, - "collaborators_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://github.com/octocat" ] }, - "comments_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat/followers" ] }, - "commits_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "compare_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contents_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/subscriptions" ] }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/orgs" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/repos" ] }, "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "merges_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "https://api.github.com/users/octocat/received_events" ] }, - "notifications_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "User" ] }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] + "site_admin": { + "type": "boolean" }, - "releases_url": { + "starred_at": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "\"2020-07-09T00:17:55Z\"" ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] + "maintain": { + "type": "boolean" }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] + "push": { + "type": "boolean" }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] + "triage": { + "type": "boolean" }, - "subscription_url": { + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "contributor_covenant" ] }, - "tags_url": { + "name": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "Contributor Covenant" ] }, - "teams_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, - "trees_url": { + "body": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "# 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" ] }, - "clone_url": { - "type": "string" - }, - "mirror_url": { + "html_url": { "type": [ "string", "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { "type": "string" }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { + "name": { "type": "string" }, - "open_issues_count": { - "type": "integer" + "spdx_id": { + "type": "string" }, - "is_template": { - "type": "boolean" + "url": { + "type": "string" }, - "topics": { - "type": "array", - "items": { - "type": "string" + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } } }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "has_wiki": { - "type": "boolean" + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + } + }, + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "has_pages": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "has_downloads": { - "type": "boolean" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "archived": { - "type": "boolean" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "disabled": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "visibility": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "pushed_at": { + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2011-01-26T19:06:43Z" + "41d064eb2195891e12d0413f63227ea7" ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "url": { + "type": "string", + "format": "uri", "examples": [ - "2011-01-26T19:01:12Z" + "https://api.github.com/users/octocat" ] }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "html_url": { + "type": "string", + "format": "uri", "examples": [ - "2011-01-26T19:14:43Z" + "https://github.com/octocat" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "temp_clone_token": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "delete_branch_on_merge": { - "type": "boolean" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "subscribers_count": { - "type": "integer" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "network_count": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "forks": { - "type": "integer", + "events_url": { + "type": "string", "examples": [ - 0 + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "open_issues": { - "type": "integer", + "received_events_url": { + "type": "string", + "format": "uri", "examples": [ - 0 + "https://api.github.com/users/octocat/received_events" ] }, - "watchers": { - "type": "integer", + "type": { + "type": "string", "examples": [ - 0 + "User" ] }, - "allow_forking": { + "site_admin": { "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "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", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "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", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", "url" ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "head_commit": { - "title": "Simple Commit", - "description": "A commit.", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "tree_id": { - "type": "string" - }, - "message": { - "type": "string" - }, - "timestamp": { - "type": "string", - "format": "date-time" - }, - "author": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - }, - "required": [ - "name", - "email" - ] - }, - "committer": { - "type": [ - "object", - "null" - ], - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - }, - "latest_check_runs_count": { - "type": "integer" - }, - "check_runs_url": { - "type": "string" - }, - "rerequestable": { - "type": "boolean" - }, - "runs_rerequestable": { - "type": "boolean" } - }, - "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" - ] - } - } - } - } - } - } - ], - "previews": [], - "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.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
OK
" - } - ] - } - ] - }, - "code-scanning": { - "code-scanning": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", - "title": "List code scanning alerts for a repository", - "category": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Set to open, fixed, or dismissed to list code scanning alerts in a specific state.
Response
", - "example": [ - { - "number": 4, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", - "html_url": "https://github.com/octocat/hello-world/code-scanning/4", - "state": "open", - "dismissed_by": null, - "dismissed_at": null, - "dismissed_reason": null, - "rule": { - "id": "js/zipslip", - "severity": "error", - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances" - }, - { - "number": 3, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", - "html_url": "https://github.com/octocat/hello-world/code-scanning/3", - "state": "dismissed", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "rule": { - "id": "js/zipslip", - "severity": "error", - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "lib/ab12-gen.js", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" ] }, - "dismissed_by": { + "inviter": { "anyOf": [ { "type": "null" @@ -132659,183 +171786,58 @@ } ] }, - "dismissed_at": { - "type": [ - "string", - "null" + "permissions": { + "description": "The permission associated with the invitation.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "examples": [ + "read" + ] }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - null, - "false positive", - "won't fix", - "used in tests" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-06-13T14:52:50-05:00" ] }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the rule used to detect the alert." - }, - "name": { - "type": "string", - "description": "The name of the rule used to detect the alert." - }, - "severity": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - } - } + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } + "url": { + "description": "URL for the repository invitation", + "type": "string", + "examples": [ + "https://api.github.com/user/repository-invitations/1" + ] }, - "most_recent_instance": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The full Git reference, formatted as `refs/heads/Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.
The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" } - ], - "subcategory": "code-scanning" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "title": "Get a code scanning alert", - "category": "code-scanning", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", + "title": "Update a repository invitation", + "category": "collaborators", + "subcategory": "invitations", "parameters": [ { "name": "owner", @@ -132890,29 +171880,45 @@ } }, { - "name": "alert_number", + "name": "invitation_id", + "description": "The unique identifier of the invitation.
", "in": "path", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.
Response
", "example": { - "number": 42, - "created_at": "2020-06-19T11:21:34Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", - "html_url": "https://github.com/octocat/hello-world/code-scanning/42", - "state": "dismissed", - "dismissed_by": { + "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": 54933897, + "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", @@ -132945,97 +172017,74 @@ "type": "User", "site_admin": false }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "rule": { - "id": "js/zipslip", - "severity": "error", - "security_severity_level": "high", - "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", - "name": "js/zipslip", - "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", - "help_uri": "https://codeql.github.com/" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "dismissed", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] + "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 }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "expired": false, + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations" }, "schema": { + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { - "number": { + "id": { + "description": "Unique identifier of the repository invitation.", "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" + "examples": [ + 42 ] }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -133195,452 +172244,776 @@ "type", "url" ] - } - ] - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - null, - "false positive", - "won't fix", - "used in tests" - ] - }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the rule used to detect the alert." }, - "name": { + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "description": "The name of the rule used to detect the alert." + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "severity": { + "description": { "type": [ "string", "null" ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null + "examples": [ + "This your first repo!" ] }, - "security_severity_level": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { "type": [ "string", "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null ] }, - "description": { + "hooks_url": { "type": "string", - "description": "A short description of the rule used to detect the alert." + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, - "full_description": { - "type": "string", - "description": "description of the rule used to detect the alert." + "svn_url": { + "type": "string" }, - "tags": { + "homepage": { "type": [ - "array", + "string", "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } + ] }, - "help": { + "language": { "type": [ "string", "null" - ], - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + ] }, - "help_uri": { + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], - "description": "A link to the documentation for the rule used to detect the alert." - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, - "version": { + "created_at": { "type": [ "string", "null" ], - "description": "The version of the tool used to generate the code scanning analysis." + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] }, - "guid": { + "updated_at": { "type": [ "string", "null" ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } - }, - "most_recent_instance": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The full Git reference, formatted as `refs/heads/Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.
Deprecation notice:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.
OK
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "subcategory": "code-scanning" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "title": "Update a code scanning alert", - "category": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "alert_number", - "in": "path", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.
Required when the state is dismissed. The reason for dismissing or closing the alert.
", - "enum": [ - null, - "false positive", - "won't fix", - "used in tests" - ] - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "state": "dismissed", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library." - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "number": 42, - "created_at": "2020-08-25T21:28:36Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", - "html_url": "https://github.com/octocat/hello-world/code-scanning/42", - "state": "dismissed", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-09-02T22:34:56Z", - "dismissed_reason": "false positive", - "rule": { - "id": "js/zipslip", - "severity": "error", - "security_severity_level": "high", - "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", - "name": "js/zipslip", - "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", - "help_uri": "https://codeql.github.com/" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "dismissed", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true + }, + "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" + ] }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" + "invitee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "dismissed_by": { + "inviter": { "anyOf": [ { "type": "null" @@ -133808,755 +173181,1488 @@ } ] }, - "dismissed_at": { - "type": [ - "string", - "null" + "permissions": { + "description": "The permission associated with the invitation.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "examples": [ + "read" + ] + }, + "created_at": { + "type": "string", "format": "date-time", - "readOnly": true + "examples": [ + "2016-06-13T14:52:50-05:00" + ] }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - null, - "false positive", - "won't fix", - "used in tests" + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" + }, + "url": { + "description": "URL for the repository invitation", + "type": "string", + "examples": [ + "https://api.github.com/user/repository-invitations/1" ] }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "description": "A unique identifier for the rule used to detect the alert." - }, - "name": { - "type": "string", - "description": "The name of the rule used to detect the alert." - }, - "severity": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "security_severity_level": { - "type": [ - "string", - "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "full_description": { - "type": "string", - "description": "description of the rule used to detect the alert." - }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { + "html_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World/invitations" + ] + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", + "url", + "html_url", + "created_at" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", + "title": "Delete a repository invitation", + "category": "collaborators", + "subcategory": "invitations", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "invitation_id": "INVITATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/user/repository_invitations", + "title": "List repository invitations for the authenticated user", + "category": "collaborators", + "subcategory": "invitations", + "parameters": [ + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "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=" + } + ], + "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.", + "type": "integer", + "examples": [ + 42 + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string" - } - }, - "help": { - "type": [ - "string", - "null" - ], - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "type": [ - "string", - "null" - ], - "description": "A link to the documentation for the rule used to detect the alert." - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } - }, - "most_recent_instance": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The full Git reference, formatted as `refs/heads/Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.
OK
" - }, - { - "httpStatusCode": "403", - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "subcategory": "code-scanning" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - "title": "List instances of a code scanning alert", - "category": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "alert_number", - "in": "path", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Response
", - "example": [ - { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "lib/ab12-gen.js", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "library" - ] - }, - { - "ref": "refs/pull/3740/merge", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "state": "fixed", - "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", - "message": { - "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." - }, - "location": { - "path": "app/script.js", - "start_line": 2, - "end_line": 2, - "start_column": 10, - "end_column": 50 - }, - "classifications": [ - "source" - ] - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The full Git reference, formatted as `refs/heads/Lists all instances of the specified code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.
OK
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "subcategory": "code-scanning" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", - "title": "List code scanning analyses for a repository", - "category": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "ref", - "in": "query", - "description": "The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Filter analyses belonging to the same SARIF upload.
", - "required": false, - "schema": { - "type": "string", - "description": "An identifier for the upload.", - "examples": [ - "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" - ] - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "ref": "refs/heads/main", - "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", - "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", - "environment": "{\"language\":\"python\"}", - "error": "", - "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", - "created_at": "2020-08-27T15:05:21Z", - "results_count": 17, - "rules_count": 49, - "id": 201, - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", - "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "deletable": true, - "warning": "" - }, - { - "ref": "refs/heads/my-branch", - "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", - "analysis_key": ".github/workflows/shiftleft.yml:build", - "environment": "{}", - "error": "", - "category": ".github/workflows/shiftleft.yml:build/", - "created_at": "2020-08-31T22:46:44Z", - "results_count": 17, - "rules_count": 32, - "id": 200, - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200", - "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582", - "tool": { - "name": "Python Security Analysis", - "guid": null, - "version": "1.2.0" - }, - "deletable": true, - "warning": "" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The full Git reference, formatted as `refs/heads/Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
You must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.
Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OK
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "subcategory": "code-scanning" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "title": "Get a code scanning analysis for a repository", - "category": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "analysis_id", - "in": "path", - "description": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
application/json response
", - "example": { - "ref": "refs/heads/main", - "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", - "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", - "environment": "{\"language\":\"javascript\"}", - "error": "", - "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", - "created_at": "2021-01-13T11:55:49Z", - "results_count": 3, - "rules_count": 67, - "id": 3602840, - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", - "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6", - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "deletable": true, - "warning": "" - }, - "schema": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The full Git reference, formatted as `refs/heads/application/json+sarif response
", - "example": { - "runs": [ - { - "tool": { - "driver": { - "name": "CodeQL", - "organization": "GitHub", - "semanticVersion": "1.0.0", - "rules": [ - { - "id": "js/unused-local-variable", - "name": "js/unused-local-variable" - } - ] - } - }, - "results": [ - { - "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38", - "message": { - "text": "Unused variable foo." - }, - "locations": [ - { - "physicalLocation": { - "artifactLocation": { - "uri": "file1.js" - }, - "region": { - "startLine": 1 - } - } - } - ], - "ruleId": "js/unused-local-variable", - "properties": [ - { - "github/alertNumber": 2 - }, - { - "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2" - } - ] - } - ] - } - ] - }, - "schema": { - "type": "object", - "additionalProperties": true - } - } - } - ], - "previews": [], - "descriptionHTML": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.
The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.
\nThe rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.
OK
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "subcategory": "code-scanning" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "title": "Delete a code scanning analysis from a repository", - "category": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "analysis_id", - "in": "path", - "description": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to true, you'll get a 400 response with the message: Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.
Default response
", - "example": { - "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", - "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" - }, - "schema": { - "title": "Analysis deletion", - "description": "Successful deletion of a code scanning analysis", - "type": "object", - "properties": { - "next_analysis_url": { - "type": [ - "string", - "null" - ], - "description": "Next deletable analysis in chain, without last analysis deletion confirmation", - "format": "uri", - "readOnly": true - }, - "confirm_delete_url": { - "type": [ - "string", - "null" - ], - "description": "Next deletable analysis in chain, with last analysis deletion confirmation", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "next_analysis_url", - "confirm_delete_url" - ] - } - } - } - ], - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "400", - "description": "Bad Request
" - }, - { - "httpStatusCode": "403", - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "descriptionHTML": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo and repo:security_events scopes.\nGitHub Apps must have the security_events write permission to use this endpoint.
You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.
\nNote: The ability to delete analyses was introduced in GitHub Enterprise Server 3.1.\nYou can delete analyses that were generated prior to installing this release,\nhowever, if you do so, you will lose information about fixed alerts for all such analyses,\nfor the relevant code scanning tool.\nWe recommend that you only delete analyses that were generated with earlier releases\nif you don't need the details of fixed alerts from pre-3.1 releases.
\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:
\n\"deletable\": true\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:
\nreftoolanalysis_keyenvironmentIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:
\nAnalysis specified is not deletable.\nThe response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set\n(see the example default response below).\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin the set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.
As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find the deletable analysis for one of the sets,\nstep through deleting the analyses in that set,\nand then repeat the process for the second set.\nThe procedure therefore consists of a nested loop:
\nOuter loop:
\nList the analyses for the repository, filtered by tool.
\nParse this list to find a deletable analysis. If found:
\nInner loop:
\nconfirm_delete_url and, if found, use this in the next iteration.The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "commit_sha", - "in": "body", - "description": "The SHA of the commit to which the analysis you are uploading relates.
", - "isRequired": true - }, - { - "type": "string", - "name": "ref", - "in": "body", - "description": "The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.
A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"
The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
" - }, - { - "type": "string", - "name": "started_at", - "in": "body", - "description": "The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.
Default response
", - "example": { - "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "An identifier for the upload.", - "examples": [ - "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" - ] - }, - "url": { - "type": "string", - "description": "The REST API URL for checking the status of the upload.", - "format": "uri", - "readOnly": true - } - } - } - } - } - ], - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "Accepted
" - }, - { - "httpStatusCode": "400", - "description": "Bad Request if the sarif field is invalid
" - }, - { - "httpStatusCode": "403", - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "413", - "description": "Payload Too Large if the sarif field is too large
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.
There are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 15 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sarif_id", - "description": "The SARIF ID obtained after uploading.
", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "sarif_id": "SARIF_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Default response
", - "example": { - "processing_status": "complete", - "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" - }, - "schema": { - "type": "object", - "properties": { - "processing_status": { - "type": "string", - "enum": [ - "pending", - "complete" - ], - "description": "`pending` files have not yet been processed, while `complete` means all results in the SARIF have been stored." - }, - "analyses_url": { - "type": [ - "string", - "null" - ], - "description": "The REST API URL for getting the analyses associated with the upload.", - "format": "uri", - "readOnly": true - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.
When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if the sarif id does not match any upload
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "subcategory": "code-scanning" - } - ] - }, - "codes-of-conduct": { - "codes-of-conduct": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/codes_of_conduct", - "title": "Get all codes of conduct", - "category": "codes-of-conduct", - "parameters": [], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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/" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - } + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/user/repository_invitations/{invitation_id}", + "title": "Accept a repository invitation", + "category": "collaborators", + "subcategory": "invitations", + "parameters": [ + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "invitation_id": "INVITATION_ID" } + }, + "response": { + "statusCode": "204", + "description": "Response
" } } ], @@ -135335,101 +174734,60 @@ "previews": [], "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "204", + "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "409", + "description": "Conflict
" } - ], - "subcategory": "codes-of-conduct" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/codes_of_conduct/{key}", - "title": "Get a code of conduct", - "category": "codes-of-conduct", + "verb": "delete", + "requestPath": "/user/repository_invitations/{invitation_id}", + "title": "Decline a repository invitation", + "category": "collaborators", + "subcategory": "invitations", "parameters": [ { - "name": "key", + "name": "invitation_id", + "description": "The unique identifier of the invitation.
", "in": "path", "required": true, "schema": { - "type": "string" - }, - "description": "" + "type": "integer" + } } ], "bodyParameters": [], - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "codeExamples": [ { - "key": "default", + "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "key": "KEY" + "invitation_id": "INVITATION_ID" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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/" - }, - "schema": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - } + "statusCode": "204", + "description": "Response
" } } ], @@ -135437,31 +174795,38 @@ "previews": [], "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "204", + "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, { "httpStatusCode": "404", "description": "Resource not found
" + }, + { + "httpStatusCode": "409", + "description": "Conflict
" } - ], - "subcategory": "codes-of-conduct" + ] } ] }, - "collaborators": { - "collaborators": [ + "commits": { + "commits": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "title": "List repository collaborators", - "category": "collaborators", - "subcategory": "collaborators", + "requestPath": "/repos/{owner}/{repo}/commits", + "title": "List commits", + "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -135482,18 +174847,50 @@ } }, { - "name": "affiliation", - "description": "Filter collaborators returned by their affiliation. outside means all outside collaborators of an organization-owned repository. direct means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. all means all collaborators the authenticated user can see.
SHA or branch to start listing commits from. Default: the repository’s default branch (usually main).
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 format: YYYY-MM-DDTHH:MM:SSZ.
Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": [ { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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 - } + "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" + } + ] } ], "schema": { "type": "array", "items": { - "title": "Collaborator", - "description": "Collaborator", + "title": "Commit", + "description": "Commit", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "starred_url": { + "sha": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "subscriptions_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "repos_url": { + "comments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "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", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "type": { - "type": "string", - "examples": [ - "User" + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "site_admin": { - "type": "boolean" + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } }, - "permissions": { + "stats": { "type": "object", "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + "additions": { + "type": "integer" }, - "push": { - "type": "boolean" + "deletions": { + "type": "integer" }, - "maintain": { - "type": "boolean" + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", + "url", + "sha", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" ] } } @@ -135746,25 +175696,37 @@ } ], "previews": [], - "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.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
\nTeam members will include the members of child teams.
\nYou must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.
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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, { "httpStatusCode": "404", "description": "Resource not found
" + }, + { + "httpStatusCode": "409", + "description": "Conflict
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "title": "Check if a user is a repository collaborator", - "category": "collaborators", - "subcategory": "collaborators", + "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + "title": "List branches for HEAD commit", + "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -135785,13 +175747,14 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.
", + "name": "commit_sha", + "description": "The SHA of the commit.
", "in": "path", "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true } ], "bodyParameters": [], @@ -135805,35 +175768,82 @@ "parameters": { "owner": "OWNER", "repo": "REPO", - "username": "USERNAME" + "commit_sha": "COMMIT_SHA" } }, "response": { - "statusCode": "204", - "description": "Response if user is a collaborator
" + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "name": "branch_5", + "commit": { + "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" + }, + "protected": false + } + ], + "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" + } + }, + "required": [ + "sha", + "url" + ] + }, + "protected": { + "type": "boolean" + } + }, + "required": [ + "name", + "commit", + "protected" + ] + } + } } } ], "previews": [], - "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.
\nYou must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and 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.
", "statusCodes": [ { - "httpStatusCode": "204", - "description": "Response if user is a collaborator
" + "httpStatusCode": "200", + "description": "OK
" }, { - "httpStatusCode": "404", - "description": "Not Found if user is not a collaborator
" + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "title": "Add a repository collaborator", - "category": "collaborators", - "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", + "title": "List pull requests associated with a commit", + "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -135854,54 +175864,71 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.
", + "name": "commit_sha", + "description": "The SHA of the commit.
", "in": "path", "required": true, "schema": { "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 } - } - ], - "bodyParameters": [ + }, { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant the collaborator. Only valid on organization-owned repositories.
", - "default": "push" + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { - "key": "new-invitation-is-created", + "key": "default", "request": { - "contentType": "application/json", - "description": "Add a collaborator with triage permissions", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "triage" - }, "parameters": { "owner": "OWNER", "repo": "REPO", - "username": "USERNAME" + "commit_sha": "COMMIT_SHA" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", - "description": "Response when a new invitation is created
", - "example": { - "id": 1, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "description": "Response
", + "example": [ + { + "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=", @@ -135921,844 +175948,1356 @@ "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" - }, - "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.", - "type": "integer", - "examples": [ - 42 - ] + "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" }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "active_lock_reason": "too heated", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:01:12Z", + "closed_at": "2011-01-26T19:01:12Z", + "merged_at": "2011-01-26T19:01:12Z", + "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + } + ], + "requested_reviewers": [ + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "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 }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "base": { + "label": "octocat:master", + "ref": "master", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", "owner": { - "title": "Simple User", - "description": "A GitHub 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 + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1347" + }, + "issue": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + }, + "author_association": "OWNER", + "auto_merge": null, + "draft": false + } + ], + "schema": { + "type": "array", + "items": { + "title": "Pull Request Simple", + "description": "Pull Request Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlB1bGxSZXF1ZXN0MQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347" + ] + }, + "diff_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.diff" + ] + }, + "patch_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1347.patch" + ] + }, + "issue_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + }, + "commits_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + ] + }, + "review_comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + ] + }, + "review_comment_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1347 + ] + }, + "state": { + "type": "string", + "examples": [ + "open" + ] + }, + "locked": { + "type": "boolean", + "examples": [ + true + ] + }, + "title": { + "type": "string", + "examples": [ + "new-feature" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "type": [ + "string", + "null" + ], + "examples": [ + "Please pull these awesome changes" + ] + }, + "labels": { + "type": "array", + "items": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { "type": "integer", - "examples": [ - 1 - ] + "format": "int64" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "type": "string" }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "name": { + "type": "string" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "description": { + "type": "string" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "color": { + "type": "string" }, - "site_admin": { + "default": { "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" + "url", + "name", + "description", + "color", + "default" ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } }, - "pull": { - "type": "boolean" - } + "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" + ] } - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "examples": [ + "too heated" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ], + "examples": [ + "e5bd3914e2e596debea16f433f57875b5b90bcd6" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "node_id": { - "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" + ] } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "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": { - "anyOf": [ - { - "type": "null" - }, - { + "assignees": { + "type": [ + "array", + "null" + ], + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -136919,14 +177458,13 @@ "url" ] } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { + }, + "requested_reviewers": { + "type": [ + "array", + "null" + ], + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -137087,1547 +177625,3675 @@ "url" ] } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World/invitations" - ] - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - } - } - } - ], - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Response when a new invitation is created
" - }, - { - "httpStatusCode": "204", - "description": "Response when:
\nForbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\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.\"
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.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou 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.
" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "title": "Remove a repository collaborator", - "category": "collaborators", - "subcategory": "collaborators", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "title": "Get repository permissions for a user", - "category": "collaborators", - "subcategory": "collaborators", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "if user has admin permissions
", - "example": { - "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 - } - }, - "schema": { - "title": "Repository Collaborator Permission", - "description": "Repository Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Collaborator", - "description": "Collaborator", + }, + "requested_teams": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "examples": [ - 1 - ] + "type": "integer" }, - "email": { - "type": [ - "string", - "null" - ] + "node_id": { + "type": "string" }, "name": { - "type": [ - "string", - "null" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "slug": { + "type": "string" }, - "gravatar_id": { + "description": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" ] }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "privacy": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "permission": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" ] }, - "organizations_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "format": "uri" }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/orgs/rails/teams/core" ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "members_url": { + "type": "string" }, - "type": { + "repositories_url": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "format": "uri" }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + "parent": { + "anyOf": [ + { + "type": "null" }, - "push": { - "type": "boolean" + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "maintain": { - "type": "boolean" + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "admin": { - "type": "boolean" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } } }, - "required": [ - "pull", - "push", - "admin" - ] - } + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "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": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": [ - "permission", - "user" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
if user has admin permissions
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - } - ], - "invitations": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/invitations", - "title": "List repository invitations", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of 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 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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=" - } - ], - "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.", - "type": "integer", - "examples": [ - 42 + "sha": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" ] }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "base": { "type": "object", "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] + "label": { + "type": "string" }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "ref": { + "type": "string" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "repo": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { - "type": [ - "string", - "null" + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "email": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "avatar_url": { + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "git:github.com/octocat/Hello-World.git" ] }, - "organizations_url": { + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "repos_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "events_url": { + "milestones_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "received_events_url": { + "notifications_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, - "type": { + "pulls_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "site_admin": { - "type": "boolean" + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] }, - "starred_at": { + "ssh_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "git@github.com:octocat/Hello-World.git" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "maintain": { - "type": "boolean" + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] }, - "push": { - "type": "boolean" + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] }, - "triage": { - "type": "boolean" + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] }, - "pull": { - "type": "boolean" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "contributor_covenant" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "name": { + "tags_url": { "type": "string", + "format": "uri", "examples": [ - "Contributor Covenant" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "url": { + "teams_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "body": { + "trees_url": { "type": "string", "examples": [ - "# 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" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "html_url": { + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { "type": [ "string", "null" ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] }, - "spdx_id": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, - "url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, - "email": { + "language": { "type": [ "string", "null" ] }, - "login": { - "type": "string", + "forks_count": { + "type": "integer", "examples": [ - "octocat" + 9 ] }, - "id": { + "stargazers_count": { "type": "integer", "examples": [ - 1 + 80 ] }, - "node_id": { - "type": "string", + "watchers_count": { + "type": "integer", "examples": [ - "MDQ6VXNlcjE=" + 80 ] }, - "avatar_url": { + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true ] }, - "gravatar_id": { + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "2011-01-26T19:06:43Z" ] }, - "url": { - "type": "string", - "format": "uri", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat" + "2011-01-26T19:01:12Z" ] }, - "html_url": { - "type": "string", - "format": "uri", + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "https://github.com/octocat" + "2011-01-26T19:14:43Z" ] }, - "followers_url": { - "type": "string", - "format": "uri", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/followers" + true ] }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } }, - "gists_url": { - "type": "string", + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + true ] }, - "starred_url": { - "type": "string", + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + false ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + false ] }, - "organizations_url": { - "type": "string", - "format": "uri", + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/orgs" + false ] }, - "repos_url": { + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, - "events_url": { + "squash_merge_commit_message": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, - "received_events_url": { + "merge_commit_title": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, - "type": { + "merge_commit_message": { "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "User" + true ] }, - "site_admin": { + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" ] }, - "inviter": { - "anyOf": [ - { - "type": "null" + "_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": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -138787,61 +181453,72 @@ "type", "url" ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" ] }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] - }, - "html_url": { - "type": "string", + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean", "examples": [ - "https://github.com/octocat/Hello-World/invitations" + false ] - }, - "node_id": { - "type": "string" } }, "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", "id", "node_id", - "permissions", - "inviter", - "invitee", - "repository", + "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", - "html_url", - "created_at" + "user", + "author_association", + "auto_merge" ] } } @@ -138849,7 +181526,7 @@ } ], "previews": [], - "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", + "descriptionHTML": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.
", "statusCodes": [ { "httpStatusCode": "200", @@ -138859,11 +181536,11 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "title": "Update a repository invitation", - "category": "collaborators", - "subcategory": "invitations", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/commits/{ref}", + "title": "Get a commit", + "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -138880,49 +181557,50 @@ "in": "path", "required": true, "schema": { - "type": "string" + "type": "string" + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 } }, { - "name": "invitation_id", - "description": "The unique identifier of the invitation.
", + "name": "ref", + "description": "ref parameter
", "in": "path", "required": true, "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permissions", - "in": "body", - "description": "The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.
Response
", "example": { - "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 + "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" }, - "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" + "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 + } }, - "invitee": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -139021,7 +181658,7 @@ "type": "User", "site_admin": false }, - "inviter": { + "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -139041,756 +181678,217 @@ "type": "User", "site_admin": false }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "expired": false, - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations" + "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....." + } + ] }, "schema": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", + "title": "Commit", + "description": "Commit", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", + "url": { + "type": "string", + "format": "uri", "examples": [ - 42 + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { "type": "object", "properties": { - "id": { - "type": "integer", + "url": { + "type": "string", + "format": "uri", "examples": [ - 1296269 + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } ] }, - "name": { + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { "type": "string", "examples": [ - "Hello-World" + "Fix all the bugs" ] }, - "full_name": { - "type": "string", + "comment_count": { + "type": "integer", "examples": [ - "octocat/Hello-World" + 0 ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "tree": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { + "sha": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "827efc6d56897b048c772eb4087f854f46256132" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "sha", "url" ] }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { + "verification": { + "title": "Verification", "type": "object", "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { + "verified": { "type": "boolean" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] + "reason": { + "type": "string" }, - "body": { - "type": "string", - "examples": [ - "# 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" + "payload": { + "type": [ + "string", + "null" ] }, - "html_url": { + "signature": { "type": [ "string", "null" - ], - "format": "uri" + ] } }, "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 + "verified", + "reason", + "payload", + "signature" ] - }, - "allow_forking": { - "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", + "author", + "committer", + "comment_count", + "message", + "tree", "url" ] }, - "invitee": { + "author": { "anyOf": [ { "type": "null" @@ -139958,7 +182056,7 @@ } ] }, - "inviter": { + "committer": { "anyOf": [ { "type": "null" @@ -140126,79 +182224,199 @@ } ] }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World/invitations" - ] + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } }, - "node_id": { - "type": "string" + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } } }, "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", "url", + "sha", + "node_id", "html_url", - "created_at" + "comments_url", + "commit", + "author", + "committer", + "parents" ] } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "title": "Delete a repository invitation", - "category": "collaborators", - "subcategory": "invitations", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", + "title": "Compare two commits", + "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -140219,52 +182437,14 @@ } }, { - "name": "invitation_id", - "description": "The unique identifier of the invitation.
", - "in": "path", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" + "type": "integer", + "default": 1 } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/user/repository_invitations", - "title": "List repository invitations for the authenticated user", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ + }, { "name": "per_page", "description": "The number of results per page (max 100).
", @@ -140275,101 +182455,72 @@ } }, { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", + "name": "basehead", + "description": "The base branch and head branch to compare. This parameter expects the format BASE...HEAD. Both must be branch names in repo. To compare with a branch that exists in a different repository in the same network as repo, the basehead parameter expects the format USERNAME:BASE...USERNAME:HEAD.
Response
", - "example": [ - { - "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 + "example": { + "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" }, - "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" + "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 + } }, - "invitee": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -140389,7 +182540,7 @@ "type": "User", "site_admin": false }, - "inviter": { + "committer": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -140409,1310 +182560,2451 @@ "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=" - } - ], - "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.", - "type": "integer", - "examples": [ - 42 - ] + "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" }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "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" + } + ] + }, + "schema": { + "title": "Commit Comparison", + "description": "Commit Comparison", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/master...topic" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/compare/master...topic" + ] + }, + "permalink_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17" + ] + }, + "diff_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/compare/master...topic.diff" + ] + }, + "patch_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/compare/master...topic.patch" + ] + }, + "base_commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "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", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { + "sha": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" ] - }, - "followers_url": { + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, - "following_url": { + "filename": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "file1.txt" ] }, - "gists_url": { + "status": { "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "added" ] }, - "starred_url": { - "type": "string", + "additions": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + 103 ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", + "deletions": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + 21 ] }, - "organizations_url": { - "type": "string", - "format": "uri", + "changes": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/orgs" + 124 ] }, - "repos_url": { + "blob_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, - "events_url": { + "raw_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] }, - "received_events_url": { + "contents_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "type": { + "patch": { "type": "string", "examples": [ - "User" + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "previous_filename": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "file.txt" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" ] + } + } + }, + "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", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "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", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" ] - }, - "subscribers_url": { + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "status": { + "type": "string", + "enum": [ + "diverged", + "ahead", + "behind", + "identical" + ], + "examples": [ + "ahead" + ] + }, + "ahead_by": { + "type": "integer", + "examples": [ + 4 + ] + }, + "behind_by": { + "type": "integer", + "examples": [ + 5 + ] + }, + "total_commits": { + "type": "integer", + "examples": [ + 6 + ] + }, + "commits": { + "type": "array", + "items": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "subscription_url": { + "sha": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "tags_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" ] }, - "teams_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "hooks_url": { + "comments_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", + "commit": { "type": "object", "properties": { - "key": { + "url": { "type": "string", + "format": "uri", "examples": [ - "contributor_covenant" + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } ] }, - "url": { + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" + "Fix all the bugs" ] }, - "body": { - "type": "string", + "comment_count": { + "type": "integer", "examples": [ - "# 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" + 0 ] }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "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", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] } }, "required": [ - "url", - "html_url", - "key", - "name" + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "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": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "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", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" ] }, - "license": { - "type": [ - "object", - "null" + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "examples": [ + "added" + ] }, - "forks": { + "additions": { "type": "integer", "examples": [ - 0 + 103 ] }, - "open_issues": { + "deletions": { "type": "integer", "examples": [ - 0 + 21 ] }, - "watchers": { + "changes": { "type": "integer", "examples": [ - 0 + 124 ] }, - "allow_forking": { - "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": { - "anyOf": [ - { - "type": "null" + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" ] } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World/invitations" - ] - }, - "node_id": { - "type": "string" } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - } + } + }, + "required": [ + "url", + "html_url", + "permalink_url", + "diff_url", + "patch_url", + "base_commit", + "merge_base_commit", + "status", + "ahead_by", + "behind_by", + "total_commits", + "commits" + ] } } } ], "previews": [], - "descriptionHTML": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
", + "descriptionHTML": "Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"
\nThis endpoint is equivalent to running the git log BASE...HEAD command, but it returns commits in a different order. The git log BASE...HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.
The API response includes details about the files that were changed between the two commits. This includes the status of the change (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.
When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.
Working with large comparisons
\nTo process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:
For more information on working with pagination, see \"Using pagination in the REST API.\"
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "title": "Accept a repository invitation", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, { "httpStatusCode": "404", "description": "Resource not found
" }, { - "httpStatusCode": "409", - "description": "Conflict
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/user/repository_invitations/{invitation_id}", - "title": "Decline a repository invitation", - "category": "collaborators", - "subcategory": "invitations", - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "invitation_id": "INVITATION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" + "httpStatusCode": "500", + "description": "Internal Error
" }, { - "httpStatusCode": "409", - "description": "Conflict
" + "httpStatusCode": "503", + "description": "Service unavailable
" } ] } - ] - }, - "commits": { - "commits": [ + ], + "comments": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits", - "title": "List commits", + "requestPath": "/repos/{owner}/{repo}/comments", + "title": "List commit comments for a repository", "category": "commits", - "subcategory": "commits", + "subcategory": "comments", "parameters": [ { "name": "owner", @@ -141732,53 +185024,6 @@ "type": "string" } }, - { - "name": "sha", - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually main).
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 format: YYYY-MM-DDTHH:MM:SSZ.
Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The number of results per page (max 100).
", @@ -141817,57 +185062,16 @@ "description": "Response
", "example": [ { - "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": { + "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=", @@ -141887,203 +185091,57 @@ "type": "User", "site_admin": false }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - ] + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "author_association": "COLLABORATOR" } ], "schema": { "type": "array", "items": { - "title": "Commit", - "description": "Commit", + "title": "Commit Comment", + "description": "Commit Comment", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } - } - ] - }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "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", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" + "html_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "body": { + "type": "string" + }, + "path": { + "type": [ + "string", + "null" ] }, - "author": { + "position": { + "type": [ + "integer", + "null" + ] + }, + "line": { + "type": [ + "integer", + "null" + ] + }, + "commit_id": { + "type": "string" + }, + "user": { "anyOf": [ { "type": "null" @@ -142251,7 +185309,1161 @@ } ] }, - "committer": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "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" + ] + } + } + } + } + ], + "previews": [], + "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.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", + "title": "Get a commit comment", + "category": "commits", + "subcategory": "comments", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "comment_id": "COMMENT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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" + }, + "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", + "null" + ] + }, + "position": { + "type": [ + "integer", + "null" + ] + }, + "line": { + "type": [ + "integer", + "null" + ] + }, + "commit_id": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "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" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", + "title": "Update a commit comment", + "category": "commits", + "subcategory": "comments", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "body", + "in": "body", + "description": "The contents of the comment
", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "body": "Nice change" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "comment_id": "COMMENT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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" + }, + "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", + "null" + ] + }, + "position": { + "type": [ + "integer", + "null" + ] + }, + "line": { + "type": [ + "integer", + "null" + ] + }, + "commit_id": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "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" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", + "title": "Delete a commit comment", + "category": "commits", + "subcategory": "comments", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "comment_id": "COMMENT_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "title": "List commit comments", + "category": "commits", + "subcategory": "comments", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "commit_sha", + "description": "The SHA of the commit.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "commit_sha": "COMMIT_SHA" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "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" + } + ], + "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", + "null" + ] + }, + "position": { + "type": [ + "integer", + "null" + ] + }, + "line": { + "type": [ + "integer", + "null" + ] + }, + "commit_id": { + "type": "string" + }, + "user": { "anyOf": [ { "type": "null" @@ -142419,162 +186631,96 @@ } ] }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - } - }, - "required": [ - "sha", - "url" - ] - } + "created_at": { + "type": "string", + "format": "date-time" }, - "stats": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "additions": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { "type": "integer" }, - "deletions": { + "+1": { "type": "integer" }, - "total": { + "-1": { "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } + "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", - "sha", - "node_id", "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" + "id", + "node_id", + "user", + "position", + "line", + "path", + "commit_id", + "body", + "author_association", + "created_at", + "updated_at" ] } } @@ -142582,37 +186728,21 @@ } ], "previews": [], - "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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Use the :commit_sha to specify the commit that will have its comments listed.
OK
" - }, - { - "httpStatusCode": "400", - "description": "Bad Request
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "409", - "description": "Conflict
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "title": "List branches for HEAD commit", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "title": "Create a commit comment", "category": "commits", - "subcategory": "commits", + "subcategory": "comments", "parameters": [ { "name": "owner", @@ -142643,14 +186773,47 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "body", + "in": "body", + "description": "The contents of the comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "in": "body", + "description": "Relative path of the file to comment on.
" + }, + { + "type": "integer", + "name": "position", + "in": "body", + "description": "Line index in the diff to comment on.
" + }, + { + "type": "integer", + "name": "line", + "in": "body", + "description": "Deprecated. Use position parameter instead. Line number in the file to comment on.
" + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "body": "Great stuff", + "path": "file1.txt", + "position": 4, + "line": 1 + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -142658,78 +186821,375 @@ } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "Response
", - "example": [ - { - "name": "branch_5", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": false - } - ], + "example": { + "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" + }, "schema": { - "type": "array", - "items": { - "title": "Branch Short", - "description": "Branch Short", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "commit": { - "type": "object", - "properties": { - "sha": { - "type": "string" + "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", + "null" + ] + }, + "position": { + "type": [ + "integer", + "null" + ] + }, + "line": { + "type": [ + "integer", + "null" + ] + }, + "commit_id": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "url": { - "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" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required": [ - "sha", - "url" - ] + "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" + } }, - "protected": { - "type": "boolean" - } - }, - "required": [ - "name", - "commit", - "protected" - ] - } + "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" + ] } } } ], "previews": [], - "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.
", + "descriptionHTML": "Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } ] - }, + } + ], + "statuses": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "title": "List pull requests associated with a commit", + "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", + "title": "Get the combined status for a specific reference", "category": "commits", - "subcategory": "commits", + "subcategory": "statuses", "parameters": [ { "name": "owner", @@ -142750,8 +187210,8 @@ } }, { - "name": "commit_sha", - "description": "The SHA of the commit.
", + "name": "ref", + "description": "ref parameter
", "in": "path", "required": true, "schema": { @@ -142789,32 +187249,49 @@ "parameters": { "owner": "OWNER", "repo": "REPO", - "commit_sha": "COMMIT_SHA" + "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": [ - { - "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": { + "example": { + "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=", @@ -142834,1183 +187311,1117 @@ "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 + "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" + }, + "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", + "null" + ] + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "context": { + "type": "string" + }, + "target_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "required": { + "type": [ + "boolean", + "null" + ] + }, + "avatar_url": { + "type": [ + "string", + "null" + ], + "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" + ] } - ], - "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 + "sha": { + "type": "string" }, - "assignees": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - { - "login": "hubot", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/hubot", - "html_url": "https://github.com/hubot", - "followers_url": "https://api.github.com/users/hubot/followers", - "following_url": "https://api.github.com/users/hubot/following{/other_user}", - "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", - "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", - "organizations_url": "https://api.github.com/users/hubot/orgs", - "repos_url": "https://api.github.com/users/hubot/repos", - "events_url": "https://api.github.com/users/hubot/events{/privacy}", - "received_events_url": "https://api.github.com/users/hubot/received_events", - "type": "User", - "site_admin": true - } - ], - "requested_reviewers": [ - { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - } - ], - "requested_teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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 + "total_count": { + "type": "integer" + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - }, - "base": { - "label": "octocat:master", - "ref": "master", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "repo": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true + "private": { + "type": "boolean" }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "html": { - "href": "https://github.com/octocat/Hello-World/pull/1347" - }, - "issue": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - }, - "comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - } - }, - "author_association": "OWNER", - "auto_merge": null, - "draft": false - } - ], - "schema": { - "type": "array", - "items": { - "title": "Pull Request Simple", - "description": "Pull Request Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlB1bGxSZXF1ZXN0MQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347" - ] - }, - "diff_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.diff" - ] - }, - "patch_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1347.patch" - ] - }, - "issue_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - }, - "commits_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" - ] - }, - "review_comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" - ] - }, - "review_comment_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - ] - }, - "statuses_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1347 - ] - }, - "state": { - "type": "string", - "examples": [ - "open" - ] - }, - "locked": { - "type": "boolean", - "examples": [ - true - ] - }, - "title": { - "type": "string", - "examples": [ - "new-feature" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } } - ] - }, - "body": { - "type": [ - "string", - "null" - ], - "examples": [ - "Please pull these awesome changes" - ] - }, - "labels": { - "type": "array", - "items": { + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] }, - "node_id": { - "type": "string" + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] }, "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { "type": "string" }, "name": { "type": "string" }, - "description": { + "spdx_id": { "type": "string" }, - "color": { + "url": { "type": "string" }, - "default": { - "type": "boolean" + "node_id": { + "type": "string" } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } } }, - "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" - ] + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } } - ] + } }, - "active_lock_reason": { + "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" + ] + } + } + } + ], + "previews": [], + "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.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessOK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", + "title": "List commit statuses for a reference", + "category": "commits", + "subcategory": "statuses", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ref", + "description": "ref parameter
", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "ref": "REF" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "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 + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Status", + "description": "The status of a commit.", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "avatar_url": { "type": [ "string", "null" - ], - "examples": [ - "too heated" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "id": { + "type": "integer" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "node_id": { + "type": "string" }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "state": { + "type": "string" }, - "merged_at": { + "description": { "type": [ "string", "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" ] }, - "merge_commit_sha": { + "target_url": { "type": [ "string", "null" - ], - "examples": [ - "e5bd3914e2e596debea16f433f57875b5b90bcd6" ] }, - "assignee": { + "context": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "creator": { "anyOf": [ { "type": "null" @@ -144177,180 +188588,216 @@ ] } ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "requested_reviewers": { - "type": [ - "array", - "null" - ], - "items": { + } + }, + "required": [ + "url", + "avatar_url", + "id", + "node_id", + "state", + "description", + "target_url", + "context", + "created_at", + "updated_at", + "creator" + ] + } + } + } + } + ], + "previews": [], + "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.
OK
" + }, + { + "httpStatusCode": "301", + "description": "Moved permanently
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", + "title": "Create a commit status", + "category": "commits", + "subcategory": "statuses", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "description": "" + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "state", + "in": "body", + "description": "The state of the status.
", + "isRequired": true, + "enum": [ + "error", + "failure", + "pending", + "success" + ] + }, + { + "type": "string or null", + "name": "target_url", + "in": "body", + "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
A short description of the status.
" + }, + { + "type": "string", + "name": "context", + "in": "body", + "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.
", + "default": "default" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "state": "success", + "target_url": "https://example.com/build/status", + "description": "The build succeeded!", + "context": "continuous-integration/jenkins" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "sha": "SHA" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "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 + } + }, + "schema": { + "title": "Status", + "description": "The status of a commit.", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "avatar_url": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "target_url": { + "type": [ + "string", + "null" + ] + }, + "context": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -144511,3495 +188958,4393 @@ "url" ] } - }, - "requested_teams": { - "type": [ - "array", - "null" - ], - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "forks": { - "type": "integer" + ] + } + }, + "required": [ + "url", + "avatar_url", + "id", + "node_id", + "state", + "description", + "target_url", + "context", + "created_at", + "updated_at", + "creator" + ] + } + } + } + ], + "previews": [], + "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.
Created
" + } + ] + } + ] + }, + "dependabot": { + "alerts": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/dependabot/alerts", + "title": "List Dependabot alerts for an enterprise", + "category": "dependabot", + "subcategory": "alerts", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.
\nCan be: dismissed, fixed, open
A comma-separated list of severities. If specified, only alerts with these severities will be returned.
\nCan be: low, medium, high, critical
A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
\nCan be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust
A comma-separated list of package names. If specified, only alerts for these packages will be returned.
", + "schema": { + "type": "string" + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.
", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "first", + "description": "Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.
Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.
The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } }, - "maintain": { - "type": "boolean" - } + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true }, - "description": { + "vector_string": { "type": [ "string", "null" ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } }, - "blobs_url": { + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] + "description": "The package's language or package management ecosystem.", + "readOnly": true }, - "branches_url": { + "name": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "email": { + "type": [ + "string", + "null" ] }, - "commits_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "octocat" ] }, - "compare_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + 1 ] }, - "contents_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "MDQ6VXNlcjE=" ] }, - "contributors_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://github.com/images/error/octocat_happy.gif" ] }, - "deployments_url": { - "type": "string", - "format": "uri", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "41d064eb2195891e12d0413f63227ea7" ] }, - "downloads_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat" ] }, - "events_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://github.com/octocat" ] }, - "forks_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/followers" ] }, - "git_commits_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "git_refs_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "git_tags_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "git_url": { + "subscriptions_url": { "type": "string", + "format": "uri", "examples": [ - "git:github.com/octocat/Hello-World.git" + "https://api.github.com/users/octocat/subscriptions" ] }, - "issue_comment_url": { + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "https://api.github.com/users/octocat/orgs" ] }, - "issue_events_url": { + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "https://api.github.com/users/octocat/repos" ] }, - "issues_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "keys_url": { + "received_events_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "https://api.github.com/users/octocat/received_events" ] }, - "labels_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "User" ] }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] + "site_admin": { + "type": "boolean" }, - "merges_url": { + "starred_at": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "\"2020-07-09T00:17:55Z\"" ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "email": { + "type": [ + "string", + "null" ] }, - "pulls_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "octocat" ] }, - "releases_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + 1 ] }, - "ssh_url": { + "node_id": { "type": "string", "examples": [ - "git@github.com:octocat/Hello-World.git" + "MDQ6VXNlcjE=" ] }, - "stargazers_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://github.com/images/error/octocat_happy.gif" ] }, - "statuses_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "subscribers_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat" ] }, - "subscription_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://github.com/octocat" ] }, - "tags_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/followers" ] }, - "teams_url": { + "following_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "trees_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "clone_url": { + "starred_url": { "type": "string", "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "hooks_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/subscriptions" ] }, - "svn_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "https://api.github.com/users/octocat/orgs" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" + "https://api.github.com/users/octocat/repos" ] }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "events_url": { + "type": "string", "examples": [ - "2011-01-26T19:01:12Z" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "received_events_url": { + "type": "string", + "format": "uri", "examples": [ - "2011-01-26T19:14:43Z" + "https://api.github.com/users/octocat/received_events" ] }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", + "type": { + "type": "string", "examples": [ - true + "User" ] }, - "template_repository": { - "type": [ - "object", - "null" - ], - "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" + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "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" + ] + } + }, + "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\nTo use this endpoint, you must be a member of the enterprise, and you must use an\naccess token with the repo scope or security_events scope.\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"Managing security managers in your organization.\"
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/dependabot/alerts", + "title": "List Dependabot alerts for an organization", + "category": "dependabot", + "subcategory": "alerts", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.
\nCan be: dismissed, fixed, open
A comma-separated list of severities. If specified, only alerts with these severities will be returned.
\nCan be: low, medium, high, critical
A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
\nCan be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust
A comma-separated list of package names. If specified, only alerts for these packages will be returned.
", + "schema": { + "type": "string" + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.
", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "first", + "description": "Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.
Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.
The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true } }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true } }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } + "required": [ + "identifier" + ], + "additionalProperties": false } }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true } }, "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" + "score", + "vector_string" + ], + "additionalProperties": false }, - "user": { - "anyOf": [ - { - "type": "null" + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "label", - "ref", - "repo", - "sha", - "user" - ] + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false }, - "base": { + "security_vulnerability": { "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "title": "Repository", - "description": "A repository on GitHub.", + "package": { "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { + "ecosystem": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "description": "The package's language or package management ecosystem.", + "readOnly": true }, "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "email": { + "type": [ + "string", + "null" ] }, - "archive_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "octocat" ] }, - "assignees_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + 1 ] }, - "blobs_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "MDQ6VXNlcjE=" ] }, - "branches_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "collaborators_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "comments_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat" ] }, - "commits_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://github.com/octocat" ] }, - "compare_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/followers" ] }, - "contents_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "contributors_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "deployments_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "downloads_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/subscriptions" ] }, - "events_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/orgs" ] }, - "forks_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/repos" ] }, - "git_commits_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "git_refs_url": { + "received_events_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "git_tags_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "User" ] }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "site_admin": { + "type": "boolean" }, - "issue_comment_url": { + "starred_at": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "\"2020-07-09T00:17:55Z\"" ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "email": { + "type": [ + "string", + "null" ] }, - "keys_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "octocat" ] }, - "labels_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + 1 ] }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "MDQ6VXNlcjE=" ] }, - "merges_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "pulls_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "releases_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/users/octocat" ] }, - "ssh_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://github.com/octocat" ] }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/followers" ] }, - "statuses_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "subscribers_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscription_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "tags_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/subscriptions" ] }, - "teams_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "clone_url": { + "repos_url": { "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/repos" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "https://api.github.com/users/octocat/received_events" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_update_branch": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true + "User" ] }, - "allow_forking": { - "description": "Whether to allow forking this repo", + "site_admin": { "type": "boolean" }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "\"2020-07-09T00:17:55Z\"" ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" } }, "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", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "sha": { - "type": "string" + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" ] } }, "required": [ - "label", - "ref", - "repo", - "sha", - "user" + "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" + ] + } + }, + "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists Dependabot alerts for an organization.
\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo scope or security_events scope.
For public repositories, you may instead use the public_repo scope.
GitHub Apps must have Dependabot alerts read permission to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dependabot/alerts", + "title": "List Dependabot alerts for a repository", + "category": "dependabot", + "subcategory": "alerts", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.
\nCan be: dismissed, fixed, open
A comma-separated list of severities. If specified, only alerts with these severities will be returned.
\nCan be: low, medium, high, critical
A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
\nCan be: composer, go, maven, npm, nuget, pip, pub, rubygems, rust
A comma-separated list of package names. If specified, only alerts for these packages will be returned.
", + "schema": { + "type": "string" + } + }, + { + "name": "manifest", + "in": "query", + "description": "A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.
", + "schema": { + "type": "string" + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.
", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "page", + "description": "Deprecated. Page number of the results to fetch. Use cursor-based pagination with before or after instead.
The number of results per page (max 100).
", + "deprecated": true, + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "first", + "description": "Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.
Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.
Response
", + "example": [ + { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2", + "html_url": "https://github.com/octocat/hello-world/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octocat/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" ] }, - "_links": { + "dependency": { "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "comments": { - "title": "Link", - "description": "Hypermedia Link", + "package": { "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, "properties": { - "href": { - "type": "string" + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true } }, "required": [ - "href" - ] + "ecosystem", + "name" + ], + "additionalProperties": false }, - "commits": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true }, - "statuses": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "html": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" - ] + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true }, - "issue": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", - "properties": { - "href": { - "type": "string" - } - }, - "required": [ - "href" + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "review_comments": { - "title": "Link", - "description": "Hypermedia Link", + "cvss": { "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, "properties": { - "href": { - "type": "string" + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true } }, "required": [ - "href" - ] + "score", + "vector_string" + ], + "additionalProperties": false }, - "review_comment": { - "title": "Link", - "description": "Hypermedia Link", + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, "properties": { - "href": { - "type": "string" + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true } }, "required": [ - "href" + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "self": { - "title": "Link", - "description": "Hypermedia Link", - "type": "object", + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, "properties": { - "href": { - "type": "string" + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true } }, "required": [ - "href" - ] - } - }, - "required": [ - "comments", - "commits", - "statuses", - "html", - "issue", - "review_comments", - "review_comment", - "self" - ] + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false }, - "author_association": { - "title": "author_association", + "url": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { "type": [ - "object", + "string", "null" ], - "properties": { - "enabled_by": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -148159,94 +193504,100 @@ "type", "url" ] - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - }, - "commit_title": { - "type": "string", - "description": "Title for the merge commit message." - }, - "commit_message": { - "type": "string", - "description": "Commit message for the merge commit." } - }, - "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" ] }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean", - "examples": [ - false + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "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", + "dependency", + "security_advisory", + "security_vulnerability", "url", - "user", - "author_association", - "auto_merge" - ] + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false } } } } ], "previews": [], - "descriptionHTML": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.
", + "descriptionHTML": "You must use an access token with the security_events scope to use this endpoint with private repositories.\nYou can also use tokens with the public_repo scope for public repositories only.\nGitHub Apps must have Dependabot alerts read permission to use this endpoint.
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}", - "title": "Get a commit", - "category": "commits", - "subcategory": "commits", + "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", + "title": "Get a Dependabot alert", + "category": "dependabot", + "subcategory": "alerts", "parameters": [ { "name": "owner", @@ -148267,32 +193618,15 @@ } }, { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "ref", - "description": "ref parameter
", + "name": "alert_number", "in": "path", + "description": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in number fields in the response from the\nGET /repos/{owner}/{repo}/dependabot/alerts operation.
Response
", "example": { - "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" + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" }, - "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 + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" }, - "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 + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" } - ], - "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....." - } - ] + "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octocat/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null }, "schema": { - "title": "Commit", - "description": "Commit", "type": "object", + "description": "A Dependabot alert.", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, - "comments_url": { + "state": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" ] }, - "commit": { + "dependency": { "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } + "required": [ + "identifier" + ], + "additionalProperties": false } - } - ] + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } }, - "message": { + "severity": { "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "tree": { + "cvss": { "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true } }, "required": [ - "sha", - "url" - ] + "score", + "vector_string" + ], + "additionalProperties": false }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } }, - "reason": { - "type": "string" + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } }, - "payload": { - "type": [ - "string", - "null" - ] + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { + "ecosystem": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "description": "The package's language or package management ecosystem.", + "readOnly": true }, - "starred_at": { + "name": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "description": "The unique package name within its ecosystem.", + "readOnly": 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" + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false } - ] + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false }, - "committer": { + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { "anyOf": [ { "type": "null" @@ -148876,253 +194301,142 @@ "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "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": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", "url", - "sha", - "node_id", "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false } } } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
You must use an access token with the security_events scope to use this endpoint with private repositories.\nYou can also use tokens with the public_repo scope for public repositories only.\nGitHub Apps must have Dependabot alerts read permission to use this endpoint.
OK
" }, { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" + "httpStatusCode": "304", + "description": "Not modified
" }, { - "httpStatusCode": "500", - "description": "Internal Error
" + "httpStatusCode": "403", + "description": "Forbidden
" }, { - "httpStatusCode": "503", - "description": "Service unavailable
" + "httpStatusCode": "404", + "description": "Resource not found
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", - "title": "Compare two commits", - "category": "commits", - "subcategory": "commits", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", + "title": "Update a Dependabot alert", + "category": "dependabot", + "subcategory": "alerts", "parameters": [ { "name": "owner", @@ -149143,46 +194457,66 @@ } }, { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", + "name": "alert_number", + "in": "path", + "description": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in number fields in the response from the\nGET /repos/{owner}/{repo}/dependabot/alerts operation.
The state of the Dependabot alert.\nA dismissed_reason must be provided when setting the state to dismissed.
The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } + "type": "string", + "name": "dismissed_reason", + "in": "body", + "description": "Required when state is dismissed. A reason for dismissing the alert.
The base branch and head branch to compare. This parameter expects the format BASE...HEAD. Both must be branch names in repo. To compare with a branch that exists in a different repository in the same network as repo, the basehead parameter expects the format USERNAME:BASE...USERNAME:HEAD.
An optional comment associated with dismissing the alert.
" } ], - "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "state": "dismissed", + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer." + }, "parameters": { "owner": "OWNER", "repo": "REPO", - "basehead": "BASEHEAD" + "alert_number": "ALERT_NUMBER" } }, "response": { @@ -149190,2531 +194524,1341 @@ "contentType": "application/json", "description": "Response
", "example": { - "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" + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 }, - "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": [ + "cwes": [ { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" } - ] - }, - "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" + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" }, - "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" + "type": "CVE", + "value": "CVE-2018-6188" } - ] - }, - "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 - } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" }, - "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 + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" }, - "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 + { + "url": "https://usn.ubuntu.com/3559-1/" }, - "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" + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" } - ] + }, + "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2", + "html_url": "https://github.com/octocat/hello-world/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null }, "schema": { - "title": "Commit Comparison", - "description": "Commit Comparison", "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/master...topic" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/compare/master...topic" - ] - }, - "permalink_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17" - ] - }, - "diff_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/compare/master...topic.diff" - ] - }, - "patch_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/compare/master...topic.patch" - ] - }, - "base_commit": { - "title": "Commit", - "description": "Commit", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } - } - ] - }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "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", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "description": "A Dependabot alert.", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "parents": { + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, "items": { "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "url": { + "severity": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "html_url": { + "vulnerable_version_range": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false } }, "required": [ - "sha", - "url" - ] + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false } }, - "stats": { + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true } - } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false }, - "files": { + "cwes": { "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, "items": { - "title": "Diff Entry", - "description": "Diff Entry", "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, "properties": { - "sha": { + "cwe_id": { "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] + "description": "The unique CWE ID.", + "readOnly": true }, - "filename": { + "name": { "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" + "CVE", + "GHSA" ] }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { + "value": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { "type": "string", + "description": "The URL of the reference.", "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] + "readOnly": true } }, "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] + "url" + ], + "additionalProperties": false } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false }, - "merge_base_commit": { - "title": "Commit", - "description": "Commit", + "security_vulnerability": { "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "node_id": { + "severity": { "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" ] }, - "html_url": { + "vulnerable_version_range": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] + "first_patched_version": { + "type": [ + "object", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "commit": { + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "url": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + "octocat" ] }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } - } + "id": { + "type": "integer", + "examples": [ + 1 ] }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } - } + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "message": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "Fix all the bugs" + "https://github.com/images/error/octocat_happy.gif" ] }, - "comment_count": { - "type": "integer", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - 0 + "41d064eb2195891e12d0413f63227ea7" ] }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] - } - }, - "required": [ - "sha", - "url" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] - } - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - } }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "deletions": { - "type": "integer" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" ] }, - "status": { - "type": "string", - "enum": [ - "diverged", - "ahead", - "behind", - "identical" + "dismissed_reason": { + "type": [ + "string", + "null" ], - "examples": [ - "ahead" + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null ] }, - "ahead_by": { - "type": "integer", - "examples": [ - 4 - ] + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 }, - "behind_by": { - "type": "integer", - "examples": [ - 5 - ] + "fixed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "You must use an access token with the security_events scope to use this endpoint with private repositories.\nYou can also use tokens with the public_repo scope for public repositories only.\nGitHub Apps must have Dependabot alerts write permission to use this endpoint.
OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "409", + "description": "Conflict
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + } + ], + "secrets": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/dependabot/secrets", + "title": "List organization secrets", + "category": "dependabot", + "subcategory": "secrets", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "total_count": 3, + "secrets": [ + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "private" }, - "total_commits": { - "type": "integer", - "examples": [ - 6 - ] + { + "name": "NPM_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "all" }, - "commits": { + { + "name": "GH_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { "type": "array", "items": { - "title": "Commit", - "description": "Commit", + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { - "url": { + "name": { + "description": "The name of the secret.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + "SECRET_TOKEN" ] }, - "sha": { + "created_at": { "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] + "format": "date-time" }, - "node_id": { + "updated_at": { "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] + "format": "date-time" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" }, - "comments_url": { + "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] - }, - "commit": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "\"Chris Wanstrath\"" - ] - }, - "email": { - "type": "string", - "examples": [ - "\"chris@ozmm.org\"" - ] - }, - "date": { - "type": "string", - "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" - ] - } - } - } - ] - }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "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", - "null" - ] - }, - "signature": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "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": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } } }, "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" + "name", + "created_at", + "updated_at", + "visibility" ] } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/dependabot/secrets/public-key", + "title": "Get an organization public key", + "category": "dependabot", + "subcategory": "secrets", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + }, + "schema": { + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + } + }, + "required": [ + "key_id", + "key" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", + "title": "Get an organization secret", + "category": "dependabot", + "subcategory": "secrets", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "name": "NPM_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + }, + "schema": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + ] } }, "required": [ - "url", - "html_url", - "permalink_url", - "diff_url", - "patch_url", - "base_commit", - "merge_base_commit", - "status", - "ahead_by", - "behind_by", - "total_commits", - "commits" + "name", + "created_at", + "updated_at", + "visibility" ] } } } ], "previews": [], - "descriptionHTML": "Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"
\nThis endpoint is equivalent to running the git log BASE...HEAD command, but it returns commits in a different order. The git log BASE...HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.
The API response includes details about the files that were changed between the two commits. This includes the status of the change (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.
When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.
Working with large comparisons
\nTo process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:
For more information on working with pagination, see \"Using pagination in the REST API.\"
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", + "title": "Create or update an organization secret", + "category": "dependabot", + "subcategory": "secrets", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "httpStatusCode": "404", - "description": "Resource not found
" + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
" }, { - "httpStatusCode": "500", - "description": "Internal Error
" + "type": "string", + "name": "key_id", + "in": "body", + "description": "ID of the key you used to encrypt the secret.
" }, { - "httpStatusCode": "503", - "description": "Service unavailable
" + "type": "string", + "name": "visibility", + "in": "body", + "description": "Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Response when creating a secret
", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + }, + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" + ] + }, + "parameters": { + "org": "ORG", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response when updating a secret
" + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Response when creating a secret
" + }, + { + "httpStatusCode": "204", + "description": "Response when updating a secret
" + } + ], + "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.
Encrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nThe organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
No Content
" } ] - } - ], - "comments": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "title": "List commit comments for a repository", - "category": "commits", - "subcategory": "comments", + "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", + "title": "List selected repositories for an organization secret", + "category": "dependabot", + "subcategory": "secrets", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -151722,8 +195866,8 @@ } }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", + "name": "secret_name", + "description": "The name of the secret.
", "in": "path", "required": true, "schema": { @@ -151731,21 +195875,21 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100).
", + "name": "page", + "description": "Page number of the results to fetch.
", "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 1 } }, { - "name": "page", - "description": "Page number of the results to fetch.
", + "name": "per_page", + "description": "The number of results per page (max 100).
", "in": "query", "schema": { "type": "integer", - "default": 1 + "default": 30 } } ], @@ -151758,101 +195902,130 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "org": "ORG", + "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": [ - { - "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" - } - ], - "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", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" + "example": { + "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 }, - "user": { - "anyOf": [ - { - "type": "null" + "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" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -151936,1027 +196109,709 @@ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "push": { + "type": "boolean" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "triage": { + "type": "boolean" }, - "repos_url": { + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "contributor_covenant" ] }, - "events_url": { + "name": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "Contributor Covenant" ] }, - "received_events_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, - "type": { + "body": { "type": "string", "examples": [ - "User" + "# 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" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "url", "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "key", + "name" ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "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" - ] - } - } - } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "title": "Get a commit comment", - "category": "commits", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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" - }, - "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", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "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" - ] - } - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "title": "Update a commit comment", - "category": "commits", - "subcategory": "comments", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "in": "body", - "description": "The contents of the comment
", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Nice change" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "comment_id": "COMMENT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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" - }, - "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", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } + "forks": { + "type": "integer", + "examples": [ + 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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "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" + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + } }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "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" + ] + } } - }, - "required": [ - "url", - "html_url", - "id", - "node_id", - "user", - "position", - "line", - "path", - "commit_id", - "body", - "author_association", - "created_at", - "updated_at" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "title": "Delete a commit comment", - "category": "commits", - "subcategory": "comments", + "verb": "put", + "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", + "title": "Set selected repositories for an organization secret", + "category": "dependabot", + "subcategory": "secrets", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -152964,36 +196819,40 @@ } }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", + "name": "secret_name", + "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" } - }, + } + ], + "bodyParameters": [ { - "name": "comment_id", - "description": "The unique identifier of the comment.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.
Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "title": "List commit comments", - "category": "commits", - "subcategory": "comments", + "verb": "put", + "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", + "title": "Add selected repository to an organization secret", + "category": "dependabot", + "subcategory": "secrets", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -153033,8 +196888,8 @@ } }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", + "name": "secret_name", + "description": "The name of the secret.
", "in": "path", "required": true, "schema": { @@ -153042,32 +196897,13 @@ } }, { - "name": "commit_sha", - "description": "The SHA of the commit.
", + "name": "repository_id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" }, - "x-multi-segment": true - }, - { - "name": "per_page", - "description": "The number of 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 - } + "description": "" } ], "bodyParameters": [], @@ -153079,380 +196915,41 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "commit_sha": "COMMIT_SHA" + "org": "ORG", + "secret_name": "SECRET_NAME", + "repository_id": "REPOSITORY_ID" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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" - } - ], - "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", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "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" - ] - } - } + "statusCode": "204", + "description": "No Content when repository was added to the selected list
" } } ], "previews": [], - "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" + "httpStatusCode": "204", + "description": "No Content when repository was added to the selected list
" + }, + { + "httpStatusCode": "409", + "description": "Conflict when visibility type is not set to selected
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "title": "Create a commit comment", - "category": "commits", - "subcategory": "comments", + "verb": "delete", + "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", + "title": "Remove selected repository from an organization secret", + "category": "dependabot", + "subcategory": "secrets", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -153460,8 +196957,8 @@ } }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", + "name": "secret_name", + "description": "The name of the secret.
", "in": "path", "required": true, "schema": { @@ -153469,446 +196966,59 @@ } }, { - "name": "commit_sha", - "description": "The SHA of the commit.
", + "name": "repository_id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "body", - "in": "body", - "description": "The contents of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "in": "body", - "description": "Relative path of the file to comment on.
" - }, - { - "type": "integer", - "name": "position", - "in": "body", - "description": "Line index in the diff to comment on.
" - }, - { - "type": "integer", - "name": "line", - "in": "body", - "description": "Deprecated. Use position parameter instead. Line number in the file to comment on.
" + "description": "" } ], + "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "body": "Great stuff", - "path": "file1.txt", - "position": 4, - "line": 1 - }, "parameters": { - "owner": "OWNER", - "repo": "REPO", - "commit_sha": "COMMIT_SHA" + "org": "ORG", + "secret_name": "SECRET_NAME", + "repository_id": "REPOSITORY_ID" } }, "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", - "example": { - "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" - }, - "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", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "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" - ] - } + "statusCode": "204", + "description": "Response when repository was removed from the selected list
" } } ], "previews": [], - "descriptionHTML": "Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
Created
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" + "httpStatusCode": "204", + "description": "Response when repository was removed from the selected list
" }, { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" + "httpStatusCode": "409", + "description": "Conflict when visibility type not set to selected
" } ] - } - ], - "statuses": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", - "title": "Get the combined status for a specific reference", - "category": "commits", - "subcategory": "statuses", + "requestPath": "/repos/{owner}/{repo}/dependabot/secrets", + "title": "List repository secrets", + "category": "dependabot", + "subcategory": "secrets", "parameters": [ { "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", + "description": "The account owner of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -153916,14 +197026,13 @@ } }, { - "name": "ref", - "description": "ref parameter
", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { "type": "string" - }, - "x-multi-segment": true + } }, { "name": "per_page", @@ -153954,8 +197063,7 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO", - "ref": "REF" + "repo": "REPO" } }, "response": { @@ -153963,162 +197071,43 @@ "contentType": "application/json", "description": "Response
", "example": { - "state": "success", - "statuses": [ + "total_count": 2, + "secrets": [ { - "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" + "name": "AZURE_DEVOPS_PAT", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" }, { - "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" + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" } - ], - "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" + ] }, "schema": { - "title": "Combined Commit Status", - "description": "Combined Commit Status", "type": "object", + "required": [ + "total_count", + "secrets" + ], "properties": { - "state": { - "type": "string" + "total_count": { + "type": "integer" }, - "statuses": { + "secrets": { "type": "array", "items": { - "title": "Simple Commit Status", + "title": "Dependabot Secret", + "description": "Set secrets for Dependabot.", "type": "object", "properties": { - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "state": { - "type": "string" - }, - "context": { - "type": "string" - }, - "target_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "required": { - "type": [ - "boolean", - "null" - ] - }, - "avatar_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { + "name": { + "description": "The name of the secret.", "type": "string", - "format": "uri" + "examples": [ + "MY_ARTIFACTORY_PASSWORD" + ] }, "created_at": { "type": "string", @@ -154130,798 +197119,333 @@ } }, "required": [ - "description", - "id", - "node_id", - "state", - "context", - "target_url", - "avatar_url", - "url", + "name", "created_at", "updated_at" ] } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key", + "title": "Get a repository public key", + "category": "dependabot", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + }, + "schema": { + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] }, - "sha": { - "type": "string" - }, - "total_count": { - "type": "integer" - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "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" + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + } + }, + "required": [ + "key_id", + "key" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", + "title": "Get a repository secret", + "category": "dependabot", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Dependabot Secret", + "description": "Set secrets for Dependabot.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "MY_ARTIFACTORY_PASSWORD" ] }, - "commit_url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time" }, - "url": { + "updated_at": { "type": "string", - "format": "uri" + "format": "date-time" } }, "required": [ - "state", - "sha", - "total_count", - "statuses", - "repository", - "commit_url", - "url" + "name", + "created_at", + "updated_at" ] } } } ], "previews": [], - "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.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessGets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", + "title": "Create or update a repository secret", + "category": "dependabot", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "httpStatusCode": "404", - "description": "Resource not found
" + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } - ] + ], + "bodyParameters": [ + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
" + }, + { + "type": "string", + "name": "key_id", + "in": "body", + "description": "ID of the key you used to encrypt the secret.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response when creating a secret
", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + }, + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response when updating a secret
" + } + } + ], + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Response when creating a secret
" + }, + { + "httpStatusCode": "204", + "description": "Response when updating a secret
" + } + ], + "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.
Encrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\nEncrypt your secret using pynacl with Python 3.
\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\nEncrypt your secret using the Sodium.Core package.
\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\nEncrypt your secret using the rbnacl gem.
\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\nref parameter
", + "name": "secret_name", + "description": "The name of the secret.
", "in": "path", "required": true, "schema": { "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "secret_name": "SECRET_NAME" + } }, - "x-multi-segment": true + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
No Content
" + } + ] + } + ] + }, + "dependency-graph": { + "dependency-review": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}", + "title": "Get a diff of the dependencies between commits", + "category": "dependency-graph", + "subcategory": "dependency-review", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { - "name": "page", - "description": "Page number of the results to fetch.
", + "name": "basehead", + "description": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format {base}...{head}.
The full path, relative to the repository root, of the dependency manifest file.
", "in": "query", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string" } } ], "bodyParameters": [], - "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -154981,7 +197563,7 @@ "parameters": { "owner": "OWNER", "repo": "REPO", - "ref": "REF" + "basehead": "BASEHEAD" } }, "response": { @@ -154990,265 +197572,170 @@ "description": "Response
", "example": [ { - "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 - } + "change_type": "removed", + "manifest": "package.json", + "ecosystem": "npm", + "name": "helmet", + "version": "4.6.0", + "package_url": "pkg:npm/helmet@4.6.0", + "license": "MIT", + "source_repository_url": "https://github.com/helmetjs/helmet", + "vulnerabilities": [] + }, + { + "change_type": "added", + "manifest": "package.json", + "ecosystem": "npm", + "name": "helmet", + "version": "5.0.0", + "package_url": "pkg:npm/helmet@5.0.0", + "license": "MIT", + "source_repository_url": "https://github.com/helmetjs/helmet", + "vulnerabilities": [] + }, + { + "change_type": "added", + "manifest": "Gemfile", + "ecosystem": "rubygems", + "name": "ruby-openid", + "version": "2.7.0", + "package_url": "pkg:gem/ruby-openid@2.7.0", + "license": null, + "source_repository_url": "https://github.com/openid/ruby-openid", + "vulnerabilities": [ + { + "severity": "critical", + "advisory_ghsa_id": "GHSA-fqfj-cmh6-hj49", + "advisory_summary": "Ruby OpenID", + "advisory_url": "https://github.com/advisories/GHSA-fqfj-cmh6-hj49" + } + ] } ], "schema": { + "title": "Dependency Graph Diff", + "description": "A diff of the dependencies between two commits.", "type": "array", "items": { - "title": "Status", - "description": "The status of a commit.", "type": "object", "properties": { - "url": { - "type": "string" + "change_type": { + "type": "string", + "enum": [ + "added", + "removed" + ] }, - "avatar_url": { - "type": [ - "string", - "null" + "manifest": { + "type": "string", + "examples": [ + "path/to/package-lock.json" ] }, - "id": { - "type": "integer" + "ecosystem": { + "type": "string", + "examples": [ + "npm" + ] }, - "node_id": { - "type": "string" + "name": { + "type": "string", + "examples": [ + "@actions/core" + ] }, - "state": { - "type": "string" + "version": { + "type": "string", + "examples": [ + "1.0.0" + ] }, - "description": { + "package_url": { "type": [ "string", "null" + ], + "examples": [ + "pkg:/npm/%40actions/core@1.1.0" ] }, - "target_url": { + "license": { "type": [ "string", "null" + ], + "examples": [ + "MIT" ] }, - "context": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" + "source_repository_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/actions" + ] }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } + "vulnerabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "severity": { + "type": "string", + "examples": [ + "critical" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "advisory_ghsa_id": { + "type": "string", + "examples": [ + "GHSA-rf4j-j272-fj86" + ] + }, + "advisory_summary": { + "type": "string", + "examples": [ + "A summary of the advisory." + ] + }, + "advisory_url": { + "type": "string", + "examples": [ + "https://github.com/advisories/GHSA-rf4j-j272-fj86" + ] + } + }, + "required": [ + "severity", + "advisory_ghsa_id", + "advisory_summary", + "advisory_url" + ] + } + }, + "scope": { + "description": "Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.", + "type": "string", + "enum": [ + "unknown", + "runtime", + "development" ] } }, "required": [ - "url", - "avatar_url", - "id", - "node_id", - "state", - "description", - "target_url", - "context", - "created_at", - "updated_at", - "creator" + "change_type", + "manifest", + "ecosystem", + "name", + "version", + "package_url", + "license", + "source_repository_url", + "vulnerabilities", + "scope" ] } } @@ -155256,25 +197743,31 @@ } ], "previews": [], - "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.
Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { - "httpStatusCode": "301", - "description": "Moved permanently
" + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" } ] - }, + } + ], + "dependency-submission": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", - "title": "Create a commit status", - "category": "commits", - "subcategory": "statuses", + "requestPath": "/repos/{owner}/{repo}/dependency-graph/snapshots", + "title": "Create a snapshot of dependencies for a repository", + "category": "dependency-graph", + "subcategory": "dependency-submission", "parameters": [ { "name": "owner", @@ -155293,70 +197786,233 @@ "schema": { "type": "string" } - }, - { - "name": "sha", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true, - "description": "" } ], "bodyParameters": [ + { + "type": "integer", + "name": "version", + "in": "body", + "description": "The version of the repository snapshot submission.
", + "isRequired": true + }, + { + "type": "object", + "name": "job", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "id", + "description": "The external ID of the job.
", + "isRequired": true + }, + { + "type": "string", + "name": "correlator", + "description": "Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of job.correlator and detector.name will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.
The url for the job.
" + } + ] + }, { "type": "string", - "name": "state", + "name": "sha", "in": "body", - "description": "The state of the status.
", + "description": "The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "The repository branch that triggered this snapshot.
", + "isRequired": true + }, + { + "type": "object", + "name": "detector", + "in": "body", + "description": "A description of the detector used.
", "isRequired": true, - "enum": [ - "error", - "failure", - "pending", - "success" + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "The name of the detector used.
", + "isRequired": true + }, + { + "type": "string", + "name": "version", + "description": "The version of the detector used.
", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "The url of the detector used.
", + "isRequired": true + } ] }, { - "type": "string or null", - "name": "target_url", + "type": "object", + "name": "metadata", "in": "body", - "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
User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
" }, { - "type": "string or null", - "name": "description", + "type": "object", + "name": "manifests", "in": "body", - "description": "A short description of the status.
" + "description": "A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.
", + "childParamsGroups": [ + { + "type": "object", + "name": "key", + "description": "A user-defined key to represent an item in manifests.
The name of the manifest.
", + "isRequired": true + }, + { + "type": "object", + "name": "file", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "source_location", + "description": "The path of the manifest file relative to the root of the Git repository.
" + } + ] + }, + { + "type": "object", + "name": "metadata", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
" + }, + { + "type": "object", + "name": "resolved", + "description": "A collection of resolved package dependencies.
", + "childParamsGroups": [ + { + "type": "object", + "name": "key", + "description": "A user-defined key to represent an item in resolved.
Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.
" + }, + { + "type": "object", + "name": "metadata", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
" + }, + { + "type": "string", + "name": "relationship", + "description": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.
", + "enum": [ + "direct", + "indirect" + ] + }, + { + "type": "string", + "name": "scope", + "description": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.
", + "enum": [ + "runtime", + "development" + ] + }, + { + "type": "array of strings", + "name": "dependencies", + "description": "Array of package-url (PURLs) of direct child dependencies.
" + } + ] + } + ] + } + ] + } + ] }, { "type": "string", - "name": "context", + "name": "scanned", "in": "body", - "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.
", - "default": "default" + "description": "The time at which the snapshot was scanned.
", + "isRequired": true } ], "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "example-of-a-dependency-submission", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "state": "success", - "target_url": "https://example.com/build/status", - "description": "The build succeeded!", - "context": "continuous-integration/jenkins" + "version": 0, + "sha": "ce587453ced02b1526dfb4cb910479d431683101", + "ref": "refs/heads/main", + "job": { + "correlator": "yourworkflowname_youractionname", + "id": "yourrunid" + }, + "detector": { + "name": "octo-detector", + "version": "0.0.1", + "url": "https://github.com/octo-org/octo-repo" + }, + "scanned": "2022-06-14T20:25:00Z", + "manifests": { + "package-lock.json": { + "name": "package-lock.json", + "file": { + "source_location": "src/package-lock.json" + }, + "resolved": { + "@actions/core": { + "package_url": "pkg:/npm/%40actions/core@1.1.9", + "dependencies": [ + "@actions/http-client" + ] + }, + "@actions/http-client": { + "package_url": "pkg:/npm/%40actions/http-client@1.0.7", + "dependencies": [ + "tunnel" + ] + }, + "tunnel": { + "package_url": "pkg:/npm/tunnel@0.0.6" + } + } + } + } }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "sha": "SHA" + "repo": "REPO" } }, "response": { @@ -155364,269 +198020,43 @@ "contentType": "application/json", "description": "Response
", "example": { - "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 - } + "id": 12345, + "created_at": "2018-05-04T01:14:52Z", + "message": "Dependency results for the repo have been successfully updated.", + "result": "SUCCESS" }, "schema": { - "title": "Status", - "description": "The status of a commit.", "type": "object", + "required": [ + "id", + "created_at", + "result", + "message" + ], "properties": { - "url": { - "type": "string" - }, - "avatar_url": { - "type": [ - "string", - "null" - ] - }, "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "state": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "target_url": { - "type": [ - "string", - "null" - ] - }, - "context": { - "type": "string" + "type": "integer", + "description": "ID of the created snapshot." }, "created_at": { - "type": "string" + "type": "string", + "description": "The time at which the snapshot was created." }, - "updated_at": { - "type": "string" + "result": { + "type": "string", + "description": "Either \"SUCCESS\", \"ACCEPTED\", or \"INVALID\". \"SUCCESS\" indicates that the snapshot was successfully created and the repository's dependencies were updated. \"ACCEPTED\" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. \"INVALID\" indicates that the snapshot was malformed." }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "message": { + "type": "string", + "description": "A message providing further details about the result, such as why the dependencies were not updated." } - }, - "required": [ - "url", - "avatar_url", - "id", - "node_id", - "state", - "description", - "target_url", - "context", - "created_at", - "updated_at", - "creator" - ] + } } } } ], "previews": [], - "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.
Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the repo scope to use this endpoint for a repository that the requesting user has access to.
Response
", - "example": {}, + "example": [ + { + "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, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z" + } + ], "schema": { "type": "array", "items": { @@ -155727,6 +198169,18 @@ }, "read_only": { "type": "boolean" + }, + "added_by": { + "type": [ + "string", + "null" + ] + }, + "last_used": { + "type": [ + "string", + "null" + ] } }, "required": [ @@ -155797,7 +198251,7 @@ "type": "boolean", "name": "read_only", "in": "body", - "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -155829,7 +198283,9 @@ "title": "octocat@octomac", "verified": true, "created_at": "2014-12-10T15:53:42Z", - "read_only": true + "read_only": true, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z" }, "schema": { "title": "Deploy Key", @@ -155856,6 +198312,18 @@ }, "read_only": { "type": "boolean" + }, + "added_by": { + "type": [ + "string", + "null" + ] + }, + "last_used": { + "type": [ + "string", + "null" + ] } }, "required": [ @@ -155945,7 +198413,9 @@ "title": "octocat@octomac", "verified": true, "created_at": "2014-12-10T15:53:42Z", - "read_only": true + "read_only": true, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z" }, "schema": { "title": "Deploy Key", @@ -155972,6 +198442,18 @@ }, "read_only": { "type": "boolean" + }, + "added_by": { + "type": [ + "string", + "null" + ] + }, + "last_used": { + "type": [ + "string", + "null" + ] } }, "required": [ @@ -156921,7 +199403,7 @@ "type": "array of strings", "name": "required_contexts", "in": "body", - "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.
" + "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.
" }, { "type": "object or string", @@ -157659,7 +200141,7 @@ } ], "previews": [], - "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.
The 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.
The 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.
By 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.
The 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.
The 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.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You 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:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\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.
This 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.
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.
The 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.
The 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.
By 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.
The 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.
The 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.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You 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:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\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.
This 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.
If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with repo or repo_deployment scopes can delete a deployment.
To set a deployment as inactive, you must:
\nFor more information, see \"Create a deployment\" and \"Create a deployment status.\"
", + "descriptionHTML": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with repo or repo_deployment scopes can delete a deployment.
To set a deployment as inactive, you must:
\nFor more information, see \"Create a deployment\" and \"Create a deployment status.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -165608,39 +208090,1687 @@ }, "schema": { "type": "object", - "additionalProperties": { - "type": "string" + "additionalProperties": { + "type": "string" + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists all the emojis available to use on GitHub Enterprise Server.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + } + ], + "subcategory": "emojis" + } + ] + }, + "enterprise-admin": { + "admin-stats": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/all", + "title": "Get all statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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 + } + }, + "schema": { + "type": "object", + "properties": { + "repos": { + "title": "Repository Enterprise Stats", + "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" + } + }, + "required": [ + "total_repos", + "root_repos", + "fork_repos", + "org_repos", + "total_pushes", + "total_wikis" + ] + }, + "hooks": { + "title": "Hooks Enterprise Stats", + "type": "object", + "properties": { + "total_hooks": { + "type": "integer" + }, + "active_hooks": { + "type": "integer" + }, + "inactive_hooks": { + "type": "integer" + } + }, + "required": [ + "total_hooks", + "active_hooks", + "inactive_hooks" + ] + }, + "pages": { + "title": "Enterprise Pages Stats", + "type": "object", + "properties": { + "total_pages": { + "type": "integer" + } + }, + "required": [ + "total_pages" + ] + }, + "orgs": { + "title": "Enterprise Organization Stats", + "type": "object", + "properties": { + "total_orgs": { + "type": "integer" + }, + "disabled_orgs": { + "type": "integer" + }, + "total_teams": { + "type": "integer" + }, + "total_team_members": { + "type": "integer" + } + }, + "required": [ + "total_orgs", + "disabled_orgs", + "total_teams", + "total_team_members" + ] + }, + "users": { + "title": "Enterprise User Stats", + "type": "object", + "properties": { + "total_users": { + "type": "integer" + }, + "admin_users": { + "type": "integer" + }, + "suspended_users": { + "type": "integer" + } + }, + "required": [ + "total_users", + "admin_users", + "suspended_users" + ] + }, + "pulls": { + "title": "Enterprise Pull Request Stats", + "type": "object", + "properties": { + "total_pulls": { + "type": "integer" + }, + "merged_pulls": { + "type": "integer" + }, + "mergeable_pulls": { + "type": "integer" + }, + "unmergeable_pulls": { + "type": "integer" + } + }, + "required": [ + "total_pulls", + "merged_pulls", + "mergeable_pulls", + "unmergeable_pulls" + ] + }, + "issues": { + "title": "Enterprise Issue Stats", + "type": "object", + "properties": { + "total_issues": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + } + }, + "required": [ + "total_issues", + "open_issues", + "closed_issues" + ] + }, + "milestones": { + "title": "Enterprise Milestone Stats", + "type": "object", + "properties": { + "total_milestones": { + "type": "integer" + }, + "open_milestones": { + "type": "integer" + }, + "closed_milestones": { + "type": "integer" + } + }, + "required": [ + "total_milestones", + "open_milestones", + "closed_milestones" + ] + }, + "gists": { + "title": "Enterprise Gist Stats", + "type": "object", + "properties": { + "total_gists": { + "type": "integer" + }, + "private_gists": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + } + }, + "required": [ + "total_gists", + "private_gists", + "public_gists" + ] + }, + "comments": { + "title": "Enterprise Comment Stats", + "type": "object", + "properties": { + "total_commit_comments": { + "type": "integer" + }, + "total_gist_comments": { + "type": "integer" + }, + "total_issue_comments": { + "type": "integer" + }, + "total_pull_request_comments": { + "type": "integer" + } + }, + "required": [ + "total_commit_comments", + "total_gist_comments", + "total_issue_comments", + "total_pull_request_comments" + ] + } + } + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/comments", + "title": "Get comment statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Enterprise Comment Stats", + "type": "object", + "properties": { + "total_commit_comments": { + "type": "integer" + }, + "total_gist_comments": { + "type": "integer" + }, + "total_issue_comments": { + "type": "integer" + }, + "total_pull_request_comments": { + "type": "integer" + } + }, + "required": [ + "total_commit_comments", + "total_gist_comments", + "total_issue_comments", + "total_pull_request_comments" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/gists", + "title": "Get gist statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Enterprise Gist Stats", + "type": "object", + "properties": { + "total_gists": { + "type": "integer" + }, + "private_gists": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + } + }, + "required": [ + "total_gists", + "private_gists", + "public_gists" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/hooks", + "title": "Get hooks statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Hooks Enterprise Stats", + "type": "object", + "properties": { + "total_hooks": { + "type": "integer" + }, + "active_hooks": { + "type": "integer" + }, + "inactive_hooks": { + "type": "integer" + } + }, + "required": [ + "total_hooks", + "active_hooks", + "inactive_hooks" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/issues", + "title": "Get issue statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Enterprise Issue Stats", + "type": "object", + "properties": { + "total_issues": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + } + }, + "required": [ + "total_issues", + "open_issues", + "closed_issues" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/milestones", + "title": "Get milestone statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Enterprise Milestone Stats", + "type": "object", + "properties": { + "total_milestones": { + "type": "integer" + }, + "open_milestones": { + "type": "integer" + }, + "closed_milestones": { + "type": "integer" + } + }, + "required": [ + "total_milestones", + "open_milestones", + "closed_milestones" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/orgs", + "title": "Get organization statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Enterprise Organization Stats", + "type": "object", + "properties": { + "total_orgs": { + "type": "integer" + }, + "disabled_orgs": { + "type": "integer" + }, + "total_teams": { + "type": "integer" + }, + "total_team_members": { + "type": "integer" + } + }, + "required": [ + "total_orgs", + "disabled_orgs", + "total_teams", + "total_team_members" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/pages", + "title": "Get pages statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Enterprise Pages Stats", + "type": "object", + "properties": { + "total_pages": { + "type": "integer" + } + }, + "required": [ + "total_pages" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/pulls", + "title": "Get pull request statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Enterprise Pull Request Stats", + "type": "object", + "properties": { + "total_pulls": { + "type": "integer" + }, + "merged_pulls": { + "type": "integer" + }, + "mergeable_pulls": { + "type": "integer" + }, + "unmergeable_pulls": { + "type": "integer" + } + }, + "required": [ + "total_pulls", + "merged_pulls", + "mergeable_pulls", + "unmergeable_pulls" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/repos", + "title": "Get repository statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Repository Enterprise Stats", + "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" + } + }, + "required": [ + "total_repos", + "root_repos", + "fork_repos", + "org_repos", + "total_pushes", + "total_wikis" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/users", + "title": "Get users statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "schema": { + "title": "Enterprise User Stats", + "type": "object", + "properties": { + "total_users": { + "type": "integer" + }, + "admin_users": { + "type": "integer" + }, + "suspended_users": { + "type": "integer" + } + }, + "required": [ + "total_users", + "admin_users", + "suspended_users" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + } + ], + "announcement": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/announcement", + "title": "Get the global announcement banner", + "category": "enterprise-admin", + "subcategory": "announcement", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Announcement banner
", + "example": { + "announcement": "Very **important** announcement about _something_.", + "expires_at": "2021-01-01T00:00:00.000+00:00", + "user_dismissible": false + }, + "schema": { + "title": "Enterprise Announcement", + "description": "Enterprise global announcement", + "type": "object", + "properties": { + "announcement": { + "type": [ + "string", + "null" + ], + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.8/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "examples": [ + "Very **important** announcement about _something_." + ] + }, + "expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "examples": [ + "\"2021-01-01T00:00:00.000-07:00\"" + ] + } + }, + "required": [ + "announcement" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets the current message and expiration date of the global announcement banner in your enterprise.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/enterprise/announcement", + "title": "Set the global announcement banner", + "category": "enterprise-admin", + "subcategory": "announcement", + "parameters": [], + "bodyParameters": [ + { + "type": "string or null", + "name": "announcement", + "in": "body", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"
", + "isRequired": true + }, + { + "type": "string or null", + "name": "expires_at", + "in": "body", + "description": "The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.
Announcement banner
", + "example": { + "announcement": "Very **important** announcement about _something_.", + "expires_at": "2021-01-01T00:00:00.000+00:00", + "user_dismissible": false + }, + "schema": { + "title": "Enterprise Announcement", + "description": "Enterprise global announcement", + "type": "object", + "properties": { + "announcement": { + "type": [ + "string", + "null" + ], + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.8/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "examples": [ + "Very **important** announcement about _something_." + ] + }, + "expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "examples": [ + "\"2021-01-01T00:00:00.000-07:00\"" + ] + } + }, + "required": [ + "announcement" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Sets the message and expiration time for the global announcement banner in your enterprise.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/enterprise/announcement", + "title": "Remove the global announcement banner", + "category": "enterprise-admin", + "subcategory": "announcement", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Removes the global announcement banner in your enterprise.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + } + ] + } + ], + "audit-log": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/audit-log", + "title": "Get the audit log for an enterprise", + "category": "enterprise-admin", + "subcategory": "audit-log", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "phrase", + "description": "A search phrase. For more information, see Searching the audit log.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "include", + "description": "The event types to include:
\nweb - returns web (non-Git) events.git - returns Git events.all - returns both web and Git events.The default is web.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "order", + "description": "The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
The default is desc.
Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#merge", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.merge", + "@timestamp": 1635940599755, + "created_at": 1635940599755, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188", + "server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b", + "request_category": "other", + "controller_action": "merge", + "url": "https://example.com/octo-org/octo-repo/pull/1/merge", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1", + "actor_session": 1, + "pull_request_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_request_review_events#create", + "device_cookie": null, + "actor": "mona-admin", + "actor_id": 7, + "business_id": 1, + "org_id": 8, + "action": "pull_request_review.submit", + "@timestamp": 1635940593079, + "created_at": 1635940593079, + "operation_type": "modify", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "PUT", + "request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b", + "server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/1/reviews", + "client_id": 322299977.1635936, + "referrer": "https://example.com/octo-org/octo-repo/pull/1/files", + "actor_session": 1, + "spammy": false, + "pull_request_id": 1, + "body": null, + "allowed": true, + "id": 1, + "state": 40, + "issue_id": 1, + "review_id": 1, + "category_type": "Resource Management" + } + }, + { + "actor_ip": "88.123.45.123", + "from": "pull_requests#create", + "device_cookie": null, + "actor": "mona", + "actor_id": 9, + "user_id": 9, + "repo": "octo-org/octo-repo", + "repo_id": 17, + "business": "github", + "business_id": 1, + "org": "octo-org", + "org_id": 8, + "action": "pull_request.create", + "@timestamp": 1635940554161, + "created_at": 1635940554161, + "operation_type": "create", + "actor_location": { + "country_code": "GB", + "country_name": "United Kingdom", + "region": "ENG", + "region_name": "England", + "city": "Louth", + "postal_code": "LN11", + "location": { + "lat": 53.4457, + "lon": 0.141 + } + }, + "data": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", + "method": "POST", + "request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305", + "server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b", + "request_category": "other", + "controller_action": "create", + "url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1", + "client_id": 386351111.163594, + "referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1", + "actor_session": 2, + "pull_request_id": 1, + "category_type": "Resource Management" + } + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "action": { + "type": "string", + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." + }, + "active": { + "type": "boolean" + }, + "active_was": { + "type": "boolean" + }, + "actor": { + "type": "string", + "description": "The actor who performed the action." + }, + "actor_id": { + "type": "integer", + "description": "The id of the actor who performed the action." + }, + "actor_location": { + "type": "object", + "properties": { + "country_name": { + "type": "string" + } + } + }, + "data": { + "type": "object", + "additionalProperties": true + }, + "org_id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, + "blocked_user": { + "type": "string", + "description": "The username of the account being blocked." + }, + "business": { + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, + "config_was": { + "type": "array", + "items": { + "type": "object" + } + }, + "content_type": { + "type": "string" + }, + "operation_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "_document_id": { + "type": "string", + "description": "A unique identifier for an audit event." + }, + "emoji": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object" + } + }, + "events_were": { + "type": "array", + "items": { + "type": "object" + } + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { + "type": "string", + "description": "The name of the repository." + }, + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } } } } } ], "previews": [], - "descriptionHTML": "Lists all the emojis available to use on GitHub Enterprise Server.
", + "descriptionHTML": "Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the read:audit_log scope.
OK
" + } + ] + } + ], + "billing": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security", + "title": "Get GitHub Advanced Security active committers for an enterprise", + "category": "enterprise-admin", + "subcategory": "billing", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Success
", + "example": { + "total_advanced_security_committers": 2, + "total_count": 2, + "repositories": [ + { + "name": "octocat-org/Hello-World", + "advanced_security_committers": 2, + "advanced_security_committers_breakdown": [ + { + "user_login": "octocat", + "last_pushed_date": "2021-11-03" + }, + { + "user_login": "octokitten", + "last_pushed_date": "2021-10-25" + } + ] + }, + { + "name": "octocat-org/server", + "advanced_security_committers": 1, + "advanced_security_committers_breakdown": [ + { + "user_login": "octokitten", + "last_pushed_date": "2021-10-26" + } + ] + } + ] + }, + "schema": { + "type": "object", + "properties": { + "total_advanced_security_committers": { + "type": "integer", + "examples": [ + 25 + ] + }, + "total_count": { + "type": "integer", + "examples": [ + 2 + ] + }, + "repositories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "advanced_security_committers": { + "type": "integer", + "examples": [ + 25 + ] + }, + "advanced_security_committers_breakdown": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user_login": { + "type": "string" + }, + "last_pushed_date": { + "type": "string", + "examples": [ + "2021-11-03" + ] + } + }, + "required": [ + "user_login", + "last_pushed_date" + ] + } + } + }, + "required": [ + "name", + "advanced_security_committers", + "advanced_security_committers_breakdown" + ] + } + } + }, + "required": [ + "repositories" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
OK
" + "description": "Success
" }, { - "httpStatusCode": "304", - "description": "Not modified
" + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" } - ], - "subcategory": "emojis" + ] } - ] - }, - "enterprise-admin": { - "admin-stats": [ + ], + "code-security-and-analysis": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/enterprise/stats/all", - "title": "Get all statistics", + "requestPath": "/enterprises/{enterprise}/code_security_and_analysis", + "title": "Get code security and analysis features for an enterprise", "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], + "subcategory": "code-security-and-analysis", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -165648,286 +209778,531 @@ "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { - "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 - } + "advanced_security_enabled_for_new_repositories": true, + "secret_scanning_enabled_for_new_repositories": true, + "secret_scanning_push_protection_enabled_for_new_repositories": true, + "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md" }, "schema": { + "title": "Enterprise Security Analysis Settings", "type": "object", "properties": { - "repos": { - "title": "Repository Enterprise Stats", - "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" - } - }, - "required": [ - "total_repos", - "root_repos", - "fork_repos", - "org_repos", - "total_pushes", - "total_wikis" + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise.", + "examples": [ + false ] }, - "hooks": { - "title": "Hooks Enterprise Stats", - "type": "object", - "properties": { - "total_hooks": { - "type": "integer" - }, - "active_hooks": { - "type": "integer" - }, - "inactive_hooks": { - "type": "integer" - } - }, - "required": [ - "total_hooks", - "active_hooks", - "inactive_hooks" + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\nenterprise.", + "examples": [ + false ] }, - "pages": { - "title": "Enterprise Pages Stats", - "type": "object", - "properties": { - "total_pages": { - "type": "integer" - } - }, - "required": [ - "total_pages" + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this enterprise.", + "examples": [ + false ] }, - "orgs": { - "title": "Enterprise Organization Stats", - "type": "object", - "properties": { - "total_orgs": { - "type": "integer" - }, - "disabled_orgs": { - "type": "integer" - }, - "total_teams": { - "type": "integer" - }, - "total_team_members": { - "type": "integer" - } - }, - "required": [ - "total_orgs", - "disabled_orgs", - "total_teams", - "total_team_members" + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" ] + } + }, + "required": [ + "advanced_security_enabled_for_new_repositories", + "secret_scanning_enabled_for_new_repositories", + "secret_scanning_push_protection_enabled_for_new_repositories" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets code security and analysis settings for the specified enterprise.\nTo use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the admin:enterprise scope.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/code_security_and_analysis", + "title": "Update code security and analysis features for an enterprise", + "category": "enterprise-admin", + "subcategory": "code-security-and-analysis", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "advanced_security_enabled_for_new_repositories", + "in": "body", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"About GitHub Advanced Security.\"
" + }, + { + "type": "boolean", + "name": "secret_scanning_enabled_for_new_repositories", + "in": "body", + "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"About secret scanning.\"
" + }, + { + "type": "boolean", + "name": "secret_scanning_push_protection_enabled_for_new_repositories", + "in": "body", + "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"Protecting pushes with secret scanning.\"
" + }, + { + "type": "string or null", + "name": "secret_scanning_push_protection_custom_link", + "in": "body", + "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.
Action started
" + } + } + ], + "previews": [], + "descriptionHTML": "Updates the settings for advanced security, secret scanning, and push protection for new repositories in an enterprise.\nTo use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the admin:enterprise scope.
Action started
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/enterprises/{enterprise}/{security_product}/{enablement}", + "title": "Enable or disable a security feature", + "category": "enterprise-admin", + "subcategory": "code-security-and-analysis", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "security_product", + "in": "path", + "description": "The security feature to enable or disable.
", + "required": true, + "schema": { + "type": "string", + "enum": [ + "advanced_security", + "secret_scanning", + "secret_scanning_push_protection" + ] + } + }, + { + "name": "enablement", + "in": "path", + "description": "The action to take.
\nenable_all means to enable the specified security feature for all repositories in the enterprise.\ndisable_all means to disable the specified security feature for all repositories in the enterprise.
Action started
" + } + } + ], + "previews": [], + "descriptionHTML": "Enables or disables the specified security feature for all repositories in an enterprise.
\nTo use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the admin:enterprise scope.
Action started
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement
" + } + ] + } + ], + "global-webhooks": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/admin/hooks", + "title": "List global webhooks", + "category": "enterprise-admin", + "subcategory": "global-webhooks", + "parameters": [ + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "type": "Global", + "id": 1, + "name": "web", + "active": true, + "events": [ + "organization", + "user" + ], + "config": { + "url": "https://example.com", + "content_type": "json", + "insecure_ssl": "0", + "secret": "********" }, - "users": { - "title": "Enterprise User Stats", - "type": "object", - "properties": { - "total_users": { - "type": "integer" - }, - "admin_users": { - "type": "integer" - }, - "suspended_users": { - "type": "integer" - } + "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" + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "required": [ - "total_users", - "admin_users", - "suspended_users" - ] - }, - "pulls": { - "title": "Enterprise Pull Request Stats", - "type": "object", - "properties": { - "total_pulls": { - "type": "integer" - }, - "merged_pulls": { - "type": "integer" - }, - "mergeable_pulls": { - "type": "integer" - }, - "unmergeable_pulls": { - "type": "integer" - } + "id": { + "type": "integer" }, - "required": [ - "total_pulls", - "merged_pulls", - "mergeable_pulls", - "unmergeable_pulls" - ] - }, - "issues": { - "title": "Enterprise Issue Stats", - "type": "object", - "properties": { - "total_issues": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - } + "name": { + "type": "string" }, - "required": [ - "total_issues", - "open_issues", - "closed_issues" - ] - }, - "milestones": { - "title": "Enterprise Milestone Stats", - "type": "object", - "properties": { - "total_milestones": { - "type": "integer" - }, - "open_milestones": { - "type": "integer" - }, - "closed_milestones": { - "type": "integer" + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" } }, - "required": [ - "total_milestones", - "open_milestones", - "closed_milestones" - ] - }, - "gists": { - "title": "Enterprise Gist Stats", - "type": "object", - "properties": { - "total_gists": { - "type": "integer" - }, - "private_gists": { - "type": "integer" - }, - "public_gists": { - "type": "integer" + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + }, + "secret": { + "type": "string" + } } }, - "required": [ - "total_gists", - "private_gists", - "public_gists" - ] + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + } + } + } + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/admin/hooks", + "title": "Create a global webhook", + "category": "enterprise-admin", + "subcategory": "global-webhooks", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "Must be passed as \"web\".
", + "isRequired": true + }, + { + "type": "object", + "name": "config", + "in": "body", + "description": "Key/value pairs to provide settings for this webhook.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "The URL to which the payloads will be delivered.
", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
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.
The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", + "example": { + "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" + }, + "schema": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "comments": { - "title": "Enterprise Comment Stats", + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { "type": "object", "properties": { - "total_commit_comments": { - "type": "integer" + "url": { + "type": "string" }, - "total_gist_comments": { - "type": "integer" + "content_type": { + "type": "string" }, - "total_issue_comments": { - "type": "integer" + "insecure_ssl": { + "type": "string" }, - "total_pull_request_comments": { - "type": "integer" + "secret": { + "type": "string" } - }, - "required": [ - "total_commit_comments", - "total_gist_comments", - "total_issue_comments", - "total_pull_request_comments" - ] + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" } } } @@ -165938,19 +210313,29 @@ "previews": [], "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "201", + "description": "Created
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/enterprise/stats/comments", - "title": "Get comment statistics", + "requestPath": "/admin/hooks/{hook_id}", + "title": "Get a global webhook", "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], + "subcategory": "global-webhooks", + "parameters": [ + { + "name": "hook_id", + "description": "The unique identifier of the hook.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -165958,35 +210343,86 @@ "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "hook_id": "HOOK_ID" + } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", + "example": { + "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" + }, "schema": { - "title": "Enterprise Comment Stats", "type": "object", "properties": { - "total_commit_comments": { - "type": "integer" + "type": { + "type": "string" }, - "total_gist_comments": { + "id": { "type": "integer" }, - "total_issue_comments": { - "type": "integer" + "name": { + "type": "string" }, - "total_pull_request_comments": { - "type": "integer" + "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" } - }, - "required": [ - "total_commit_comments", - "total_gist_comments", - "total_issue_comments", - "total_pull_request_comments" - ] + } } } } @@ -166002,45 +210438,202 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/gists", - "title": "Get gist statistics", + "verb": "patch", + "requestPath": "/admin/hooks/{hook_id}", + "title": "Update a global webhook", "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], + "subcategory": "global-webhooks", + "parameters": [ + { + "name": "hook_id", + "description": "The unique identifier of the hook.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "object", + "name": "config", + "in": "body", + "description": "Key/value pairs to provide settings for this webhook.
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "The URL to which the payloads will be delivered.
", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
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.
The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", + "example": { + "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" + }, "schema": { - "title": "Enterprise Gist Stats", "type": "object", "properties": { - "total_gists": { - "type": "integer" + "type": { + "type": "string" }, - "private_gists": { + "id": { "type": "integer" }, - "public_gists": { - "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" } - }, - "required": [ - "total_gists", - "private_gists", - "public_gists" - ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/admin/hooks/{hook_id}", + "title": "Delete a global webhook", + "category": "enterprise-admin", + "subcategory": "global-webhooks", + "parameters": [ + { + "name": "hook_id", + "description": "The unique identifier of the hook.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "hook_id": "HOOK_ID" } + }, + "response": { + "statusCode": "204", + "description": "Response
" } } ], @@ -166048,19 +210641,29 @@ "previews": [], "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "204", + "description": "No Content
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/hooks", - "title": "Get hooks statistics", + "verb": "post", + "requestPath": "/admin/hooks/{hook_id}/pings", + "title": "Ping a global webhook", "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], + "subcategory": "global-webhooks", + "parameters": [ + { + "name": "hook_id", + "description": "The unique identifier of the hook.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -166068,90 +210671,143 @@ "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "hook_id": "HOOK_ID" + } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "schema": { - "title": "Hooks Enterprise Stats", - "type": "object", - "properties": { - "total_hooks": { - "type": "integer" - }, - "active_hooks": { - "type": "integer" - }, - "inactive_hooks": { - "type": "integer" - } - }, - "required": [ - "total_hooks", - "active_hooks", - "inactive_hooks" - ] - } + "statusCode": "204", + "description": "Response
" } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "This will trigger a ping event to be sent to the webhook.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "204", + "description": "No Content
" } ] - }, + } + ], + "ldap": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/issues", - "title": "Get issue statistics", + "verb": "patch", + "requestPath": "/admin/ldap/teams/{team_id}/mapping", + "title": "Update LDAP mapping for a team", "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], + "subcategory": "ldap", + "parameters": [ + { + "name": "team_id", + "description": "The unique identifier of the team.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "ldap_dn", + "in": "body", + "description": "The distinguished name (DN) of the LDAP entry to map to a team.
", + "isRequired": true + } + ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "parameters": { + "team_id": "TEAM_ID" + } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", + "example": { + "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://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + }, "schema": { - "title": "Enterprise Issue Stats", "type": "object", "properties": { - "total_issues": { - "type": "integer" + "ldap_dn": { + "type": "string" }, - "open_issues": { + "id": { "type": "integer" }, - "closed_issues": { - "type": "integer" + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "null" + ] } - }, - "required": [ - "total_issues", - "open_issues", - "closed_issues" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -166161,12 +210817,22 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/milestones", - "title": "Get milestone statistics", + "verb": "post", + "requestPath": "/admin/ldap/teams/{team_id}/sync", + "title": "Sync LDAP mapping for a team", "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], + "subcategory": "ldap", + "parameters": [ + { + "name": "team_id", + "description": "The unique identifier of the team.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -166174,87 +210840,468 @@ "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "team_id": "TEAM_ID" + } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "Response
", + "example": { + "status": "queued" + }, "schema": { - "title": "Enterprise Milestone Stats", "type": "object", "properties": { - "total_milestones": { - "type": "integer" - }, - "open_milestones": { - "type": "integer" - }, - "closed_milestones": { - "type": "integer" + "status": { + "type": "string" } - }, - "required": [ - "total_milestones", - "open_milestones", - "closed_milestones" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "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.
OK
" + "httpStatusCode": "201", + "description": "Created
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/orgs", - "title": "Get organization statistics", + "verb": "patch", + "requestPath": "/admin/ldap/users/{username}/mapping", + "title": "Update LDAP mapping for a user", "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], - "bodyParameters": [], + "subcategory": "ldap", + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "ldap_dn", + "in": "body", + "description": "The distinguished name (DN) of the LDAP entry to map to a team.
", + "isRequired": true + } + ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" + }, + "parameters": { + "username": "USERNAME" + } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", + "example": { + "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, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "private_gists": 81, + "total_private_repos": 100, + "owned_private_repos": 100, + "disk_usage": 10000, + "collaborators": 8, + "two_factor_authentication": true, + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "collaborators": 0 + } + }, "schema": { - "title": "Enterprise Organization Stats", + "title": "Ldap Private User", + "description": "Ldap Private User", "type": "object", "properties": { - "total_orgs": { - "type": "integer" + "ldap_dn": { + "type": "string" }, - "disabled_orgs": { - "type": "integer" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "total_teams": { - "type": "integer" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "total_team_members": { - "type": "integer" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa octocat" + ] + }, + "company": { + "type": [ + "string", + "null" + ], + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": [ + "string", + "null" + ], + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ], + "examples": [ + "There once was..." + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "private_gists": { + "type": "integer", + "examples": [ + 81 + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "disk_usage": { + "type": "integer", + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": "integer", + "examples": [ + 8 + ] + }, + "two_factor_authentication": { + "type": "boolean", + "examples": [ + 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" + }, + "business_plus": { + "type": "boolean" } }, "required": [ - "total_orgs", - "disabled_orgs", - "total_teams", - "total_team_members" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" ] } } @@ -166271,12 +211318,22 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprise/stats/pages", - "title": "Get pages statistics", + "verb": "post", + "requestPath": "/admin/ldap/users/{username}/sync", + "title": "Sync LDAP mapping for a user", "category": "enterprise-admin", - "subcategory": "admin-stats", - "parameters": [], + "subcategory": "ldap", + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -166284,43 +211341,47 @@ "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "Response
", + "example": { + "status": "queued" + }, "schema": { - "title": "Enterprise Pages Stats", "type": "object", "properties": { - "total_pages": { - "type": "integer" + "status": { + "type": "string" } - }, - "required": [ - "total_pages" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "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.
OK
" + "httpStatusCode": "201", + "description": "Created
" } ] - }, + } + ], + "license": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/enterprise/stats/pulls", - "title": "Get pull request statistics", + "requestPath": "/enterprise/settings/license", + "title": "Get license information", "category": "enterprise-admin", - "subcategory": "admin-stats", + "subcategory": "license", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, @@ -166335,29 +211396,50 @@ "statusCode": "200", "contentType": "application/json", "description": "Response
", + "example": { + "seats": 1400, + "seats_used": 1316, + "seats_available": 84, + "kind": "standard", + "days_until_expiration": 365, + "expire_at": "2016/02/06 12:41:52 -0600" + }, "schema": { - "title": "Enterprise Pull Request Stats", "type": "object", "properties": { - "total_pulls": { - "type": "integer" + "seats": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] }, - "merged_pulls": { + "seats_used": { "type": "integer" }, - "mergeable_pulls": { - "type": "integer" + "seats_available": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] }, - "unmergeable_pulls": { + "kind": { + "type": "string" + }, + "days_until_expiration": { "type": "integer" + }, + "expire_at": { + "type": "string" } - }, - "required": [ - "total_pulls", - "merged_pulls", - "mergeable_pulls", - "unmergeable_pulls" - ] + } } } } @@ -166370,14 +211452,16 @@ "description": "OK
" } ] - }, + } + ], + "management-console": [ { - "serverUrl": "http(s)://HOSTNAME/api/v3", + "serverUrl": "http(s)://HOSTNAME", "verb": "get", - "requestPath": "/enterprise/stats/repos", - "title": "Get repository statistics", + "requestPath": "/setup/api/configcheck", + "title": "Get the configuration status", "category": "enterprise-admin", - "subcategory": "admin-stats", + "subcategory": "management-console", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, @@ -166392,43 +211476,62 @@ "statusCode": "200", "contentType": "application/json", "description": "Response
", - "schema": { - "title": "Repository Enterprise Stats", - "type": "object", - "properties": { - "total_repos": { - "type": "integer" - }, - "root_repos": { - "type": "integer" + "example": { + "status": "running", + "progress": [ + { + "status": "DONE", + "key": "Appliance core components" }, - "fork_repos": { - "type": "integer" + { + "status": "DONE", + "key": "GitHub utilities" }, - "org_repos": { - "type": "integer" + { + "status": "DONE", + "key": "GitHub applications" }, - "total_pushes": { - "type": "integer" + { + "status": "CONFIGURING", + "key": "GitHub services" }, - "total_wikis": { - "type": "integer" + { + "status": "PENDING", + "key": "Reloading appliance services" } - }, - "required": [ - "total_repos", - "root_repos", - "fork_repos", - "org_repos", - "total_pushes", - "total_wikis" ] + }, + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "progress": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "key": { + "type": "string" + } + }, + "required": [ + "status", + "key" + ] + } + } + } } } } ], - "descriptionHTML": "", "previews": [], + "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 |
Response
", - "schema": { - "title": "Enterprise User Stats", - "type": "object", - "properties": { - "total_users": { - "type": "integer" - }, - "admin_users": { - "type": "integer" - }, - "suspended_users": { - "type": "integer" - } - }, - "required": [ - "total_users", - "admin_users", - "suspended_users" - ] - } + "statusCode": "202", + "description": "Response
" } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "202", + "description": "Accepted
" } ] - } - ], - "announcement": [ + }, { - "serverUrl": "http(s)://HOSTNAME/api/v3", + "serverUrl": "http(s)://HOSTNAME", "verb": "get", - "requestPath": "/enterprise/announcement", - "title": "Get the global announcement banner", + "requestPath": "/setup/api/maintenance", + "title": "Get the maintenance status", "category": "enterprise-admin", - "subcategory": "announcement", + "subcategory": "management-console", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, @@ -166511,48 +211591,63 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Announcement banner
", + "description": "Response
", "example": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false + "status": "scheduled", + "scheduled_time": "Tuesday, January 22 at 15:34 -0800", + "connection_services": [ + { + "name": "git operations", + "number": 0 + }, + { + "name": "mysql queries", + "number": 233 + }, + { + "name": "aqueduct jobs", + "number": 34 + }, + { + "name": "resque jobs", + "number": 54 + } + ] }, "schema": { - "title": "Enterprise Announcement", - "description": "Enterprise global announcement", "type": "object", "properties": { - "announcement": { - "type": [ - "string", - "null" - ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.3/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "examples": [ - "Very **important** announcement about _something_." - ] + "status": { + "type": "string" }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "examples": [ - "\"2021-01-01T00:00:00.000-07:00\"" - ] + "scheduled_time": { + "type": "string" + }, + "connection_services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "number": { + "type": "integer" + } + }, + "required": [ + "name", + "number" + ] + } } - }, - "required": [ - "announcement" - ] + } } } } ], "previews": [], - "descriptionHTML": "Gets the current message and expiration date of the global announcement banner in your enterprise.
", + "descriptionHTML": "Check your installation's maintenance status:
", "statusCodes": [ { "httpStatusCode": "200", @@ -166561,26 +211656,20 @@ ] }, { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/enterprise/announcement", - "title": "Set the global announcement banner", + "serverUrl": "http(s)://HOSTNAME", + "verb": "post", + "requestPath": "/setup/api/maintenance", + "title": "Enable or disable maintenance mode", "category": "enterprise-admin", - "subcategory": "announcement", + "subcategory": "management-console", "parameters": [], "bodyParameters": [ { - "type": "string or null", - "name": "announcement", + "type": "string", + "name": "maintenance", "in": "body", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"
", + "description": "A JSON string with the attributes enabled and when.
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.
The possible values for when are now or any date parseable by mojombo/chronic.
The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.
Announcement banner
", + "description": "Response
", "example": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false + "status": "scheduled", + "scheduled_time": "Tuesday, January 22 at 15:34 -0800", + "connection_services": [ + { + "name": "git operations", + "number": 0 + }, + { + "name": "mysql queries", + "number": 233 + }, + { + "name": "aqueduct jobs", + "number": 34 + }, + { + "name": "resque jobs", + "number": 54 + } + ] }, "schema": { - "title": "Enterprise Announcement", - "description": "Enterprise global announcement", "type": "object", "properties": { - "announcement": { - "type": [ - "string", - "null" - ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.3/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "examples": [ - "Very **important** announcement about _something_." - ] + "status": { + "type": "string" }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "examples": [ - "\"2021-01-01T00:00:00.000-07:00\"" - ] + "scheduled_time": { + "type": "string" + }, + "connection_services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "number": { + "type": "integer" + } + }, + "required": [ + "name", + "number" + ] + } } - }, - "required": [ - "announcement" - ] + } } } } ], "previews": [], - "descriptionHTML": "Sets the message and expiration time for the global announcement banner in your enterprise.
", + "descriptionHTML": "Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
Response
" - } - } - ], - "previews": [], - "descriptionHTML": "Removes the global announcement banner in your enterprise.
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ] - } - ], - "audit-log": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/audit-log", - "title": "Get the audit log for an enterprise", - "category": "enterprise-admin", - "subcategory": "audit-log", - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "phrase", - "description": "A search phrase. For more information, see Searching the audit log.
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "order", - "description": "The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
The default is desc.
Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": [ - { - "actor_ip": "88.123.45.123", - "from": "pull_requests#merge", - "device_cookie": null, - "actor": "mona-admin", - "actor_id": 7, - "repo": "octo-org/octo-repo", - "repo_id": 17, - "business": "github", - "business_id": 1, - "org": "octo-org", - "org_id": 8, - "action": "pull_request.merge", - "@timestamp": 1635940599755, - "created_at": 1635940599755, - "operation_type": "modify", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 - } + "example": { + "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": "" }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "POST", - "request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188", - "server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b", - "request_category": "other", - "controller_action": "merge", - "url": "https://example.com/octo-org/octo-repo/pull/1/merge", - "client_id": 322299977.1635936, - "referrer": "https://example.com/octo-org/octo-repo/pull/1", - "actor_session": 1, - "pull_request_id": 1, - "category_type": "Resource Management" - } - }, - { - "actor_ip": "88.123.45.123", - "from": "pull_request_review_events#create", - "device_cookie": null, - "actor": "mona-admin", - "actor_id": 7, - "business_id": 1, - "org_id": 8, - "action": "pull_request_review.submit", - "@timestamp": 1635940593079, - "created_at": 1635940593079, - "operation_type": "modify", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 - } + "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" }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "PUT", - "request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b", - "server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89", - "request_category": "other", - "controller_action": "create", - "url": "https://example.com/octo-org/octo-repo/pull/1/reviews", - "client_id": 322299977.1635936, - "referrer": "https://example.com/octo-org/octo-repo/pull/1/files", - "actor_session": 1, - "spammy": false, - "pull_request_id": 1, - "body": null, - "allowed": true, - "id": 1, - "state": 40, - "issue_id": 1, - "review_id": 1, - "category_type": "Resource Management" - } - }, - { - "actor_ip": "88.123.45.123", - "from": "pull_requests#create", - "device_cookie": null, - "actor": "mona", - "actor_id": 9, - "user_id": 9, - "repo": "octo-org/octo-repo", - "repo_id": 17, - "business": "github", - "business_id": 1, - "org": "octo-org", - "org_id": 8, - "action": "pull_request.create", - "@timestamp": 1635940554161, - "created_at": 1635940554161, - "operation_type": "create", - "actor_location": { - "country_code": "GB", - "country_name": "United Kingdom", - "region": "ENG", - "region_name": "England", - "city": "Louth", - "postal_code": "LN11", - "location": { - "lat": 53.4457, - "lon": 0.141 + "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 } }, - "data": { - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...", - "method": "POST", - "request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305", - "server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b", - "request_category": "other", - "controller_action": "create", - "url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1", - "client_id": 386351111.163594, - "referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1", - "actor_session": 2, - "pull_request_id": 1, - "category_type": "Resource Management" - } - } - ], + "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]" + ] + }, "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "@timestamp": { - "type": "integer", - "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "action": { - "type": "string", - "description": "The name of the action that was performed, for example `user.login` or `repo.create`." - }, - "active": { - "type": "boolean" - }, - "active_was": { - "type": "boolean" - }, - "actor": { - "type": "string", - "description": "The actor who performed the action." - }, - "actor_id": { - "type": "integer", - "description": "The id of the actor who performed the action." - }, - "actor_location": { - "type": "object", - "properties": { - "country_name": { - "type": "string" + "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": { + "type": [ + "string", + "null" + ] + }, + "auth_mode": { + "type": "string" + }, + "expire_sessions": { + "type": "boolean" + }, + "admin_password": { + "type": [ + "string", + "null" + ] + }, + "configuration_id": { + "type": "integer" + }, + "configuration_run_count": { + "type": "integer" + }, + "avatar": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "uri": { + "type": "string" + } } - } - }, - "data": { - "type": "object", - "additionalProperties": true - }, - "org_id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "business_id": { - "type": "integer" - }, - "blocked_user": { - "type": "string", - "description": "The username of the account being blocked." - }, - "business": { - "type": "string" - }, - "config": { - "type": "array", - "items": { - "type": "object" - } - }, - "config_was": { - "type": "array", - "items": { - "type": "object" - } - }, - "content_type": { - "type": "string" - }, - "operation_type": { - "type": "string" - }, - "created_at": { - "type": "integer", - "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "deploy_key_fingerprint": { - "type": "string" - }, - "_document_id": { - "type": "string", - "description": "A unique identifier for an audit event." - }, - "emoji": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "object" - } - }, - "events_were": { - "type": "array", - "items": { - "type": "object" - } - }, - "explanation": { - "type": "string" - }, - "fingerprint": { - "type": "string" - }, - "hook_id": { - "type": "integer" - }, - "limited_availability": { - "type": "boolean" - }, - "message": { - "type": "string" - }, - "name": { - "type": "string" - }, - "old_user": { - "type": "string" - }, - "openssh_public_key": { - "type": "string" - }, - "org": { - "type": "string" - }, - "previous_visibility": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "repo": { - "type": "string", - "description": "The name of the repository." - }, - "repository": { - "type": "string", - "description": "The name of the repository." - }, - "repository_public": { - "type": "boolean" - }, - "target_login": { - "type": "string" - }, - "team": { + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "key": { + "type": [ + "string", + "null" + ] + } + } + }, + "ldap": { + "type": "object", + "properties": { + "host": { + "type": [ + "string", + "null" + ] + }, + "port": { + "type": "integer" + }, + "base": { + "type": "array", + "items": {} + }, + "uid": { + "type": [ + "string", + "null" + ] + }, + "bind_dn": { + "type": [ + "string", + "null" + ] + }, + "password": { + "type": [ + "string", + "null" + ] + }, + "method": { + "type": "string" + }, + "search_strategy": { + "type": "string" + }, + "user_groups": { + "type": "array", + "items": {} + }, + "admin_group": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "org": { + "type": [ + "string", + "null" + ] + } + } + }, + "profile": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "mail": { + "type": [ + "string", + "null" + ] + }, + "key": { + "type": [ + "string", + "null" + ] + } + } + } + } + }, + "cas": { + "type": "object", + "properties": { + "url": { + "type": [ + "string", + "null" + ] + } + } + }, + "saml": { + "type": "object", + "properties": { + "sso_url": { + "type": [ + "string", + "null" + ] + }, + "certificate": { + "type": [ + "string", + "null" + ] + }, + "certificate_path": { + "type": [ + "string", + "null" + ] + }, + "issuer": { + "type": [ + "string", + "null" + ] + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "snmp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "community": { + "type": "string" + } + } + }, + "syslog": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "type": [ + "string", + "null" + ] + }, + "protocol_name": { + "type": "string" + } + } + }, + "assets": { + "type": [ + "string", + "null" + ] + }, + "pages": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "collectd": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "type": [ + "string", + "null" + ] + }, + "port": { + "type": "integer" + }, + "encryption": { + "type": [ + "string", + "null" + ] + }, + "username": { + "type": [ + "string", + "null" + ] + }, + "password": { + "type": [ + "string", + "null" + ] + } + } + }, + "mapping": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "tileserver": { + "type": [ + "string", + "null" + ] + }, + "basemap": { + "type": "string" + }, + "token": { + "type": [ + "string", + "null" + ] + } + } + }, + "load_balancer": { + "type": [ + "string", + "null" + ] + } + } + }, + "run_list": { + "type": "array", + "items": { "type": "string" - }, - "transport_protocol": { - "type": "integer", - "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "transport_protocol_name": { - "type": "string", - "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "user": { - "type": "string", - "description": "The user that was affected by the action performed (if available)." - }, - "visibility": { - "type": "string", - "description": "The repository visibility, for example `public` or `private`." } } } @@ -167081,43 +212403,66 @@ } ], "previews": [], - "descriptionHTML": "Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise scope.
Gets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote: You cannot retrieve the management console password with the Enterprise administration API.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] - } - ], - "global-webhooks": [ + }, { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/hooks", - "title": "List global webhooks", + "serverUrl": "http(s)://HOSTNAME", + "verb": "put", + "requestPath": "/setup/api/settings", + "title": "Set settings", "category": "enterprise-admin", - "subcategory": "global-webhooks", - "parameters": [ + "subcategory": "management-console", + "parameters": [], + "bodyParameters": [ { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, + "type": "string", + "name": "settings", + "in": "body", + "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.
", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 + "key": "204", + "request": { + "contentType": "application/x-www-form-urlencoded", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "settings": "{ \"enterprise\": { \"public_pages\": true }}" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" } } ], + "previews": [], + "descriptionHTML": "Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.
\nNotes:
\napplication/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"No Content
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME", + "verb": "get", + "requestPath": "/setup/api/settings/authorized-keys", + "title": "Get all authorized SSH keys", + "category": "enterprise-admin", + "subcategory": "management-console", + "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -167133,24 +212478,16 @@ "description": "Response
", "example": [ { - "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" + "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" + }, + { + "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" } ], "schema": { @@ -167158,51 +212495,10 @@ "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": { + "key": { "type": "string" }, - "ping_url": { + "pretty-print": { "type": "string" } } @@ -167221,63 +212517,20 @@ ] }, { - "serverUrl": "http(s)://HOSTNAME/api/v3", + "serverUrl": "http(s)://HOSTNAME", "verb": "post", - "requestPath": "/admin/hooks", - "title": "Create a global webhook", + "requestPath": "/setup/api/settings/authorized-keys", + "title": "Add an authorized SSH key", "category": "enterprise-admin", - "subcategory": "global-webhooks", + "subcategory": "management-console", "parameters": [], "bodyParameters": [ { "type": "string", - "name": "name", + "name": "authorized_key", "in": "body", - "description": "Must be passed as \"web\".
", + "description": "The public SSH key.
", "isRequired": true - }, - { - "type": "object", - "name": "config", - "in": "body", - "description": "Key/value pairs to provide settings for this webhook.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "The URL to which the payloads will be delivered.
", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
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.
The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", - "example": { - "type": "Global", - "id": 1, - "name": "web", - "active": true, - "events": [ - "organization", - "user" - ], - "config": { - "url": "https://example.com", - "content_type": "json", - "insecure_ssl": "0", - "secret": "********" + "example": [ + { + "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" }, - "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" - }, + { + "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" + } + ], "schema": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "events": { - "type": "array", - "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "pretty-print": { "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" } } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
The unique identifier of the hook.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } + "type": "string", + "name": "authorized_key", + "in": "body", + "description": "The public SSH key.
", + "isRequired": true } ], - "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/x-www-form-urlencoded", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "hook_id": "HOOK_ID" + "bodyParameters": { + "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": { - "type": "Global", - "id": 1, - "name": "web", - "active": true, - "events": [ - "organization", - "user" - ], - "config": { - "url": "https://example.com", - "content_type": "json", - "insecure_ssl": "0", - "secret": "********" + "example": [ + { + "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" }, - "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" - }, + { + "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" + } + ], "schema": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "events": { - "type": "array", - "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "pretty-print": { "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" } } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
The unique identifier of the hook.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "subcategory": "management-console", + "parameters": [], "bodyParameters": [ { - "type": "object", - "name": "config", + "type": "string", + "name": "license", "in": "body", - "description": "Key/value pairs to provide settings for this webhook.
", - "childParamsGroups": [ - { - "type": "string", - "name": "url", - "description": "The URL to which the payloads will be delivered.
", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
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.
The content of your .ghl license file.
", + "isRequired": true }, { - "type": "array of strings", - "name": "events", + "type": "string", + "name": "password", "in": "body", - "description": "The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.
" }, { - "type": "boolean", - "name": "active", + "type": "string", + "name": "settings", "in": "body", - "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.
" } ], "enabledForGitHubApps": false, @@ -167574,124 +212696,141 @@ { "key": "default", "request": { - "contentType": "application/json", + "contentType": "multipart/form-data", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "events": [ - "organization" - ], - "config": { - "url": "https://example.com/webhook" - } - }, - "parameters": { - "hook_id": "HOOK_ID" + "license": "@enterprise.ghl", + "password": "secret" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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" - }, - "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" - } - } - } + "statusCode": "202", + "description": "Response
" } } ], "previews": [], - "descriptionHTML": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.
", + "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.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote: The request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
OK
" + "httpStatusCode": "202", + "description": "Accepted
" } ] }, + { + "serverUrl": "http(s)://HOSTNAME", + "verb": "post", + "requestPath": "/setup/api/upgrade", + "title": "Upgrade a license", + "category": "enterprise-admin", + "subcategory": "management-console", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "license", + "in": "body", + "description": "The content of your new .ghl license file.
" + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "multipart/form-data", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "license": "@enterprise.ghl" + } + }, + "response": { + "statusCode": "202", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "This API upgrades your license and also triggers the configuration process.
\nNote: The request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Accepted
" + } + ] + } + ], + "org-pre-receive-hooks": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/hooks/{hook_id}", - "title": "Delete a global webhook", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks", + "title": "List pre-receive hooks for an organization", "category": "enterprise-admin", - "subcategory": "global-webhooks", + "subcategory": "org-pre-receive-hooks", "parameters": [ { - "name": "hook_id", - "description": "The unique identifier of the hook.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of 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": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" } } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -167699,35 +212838,77 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "hook_id": "HOOK_ID" + "org": "ORG" } }, "response": { - "statusCode": "204", - "description": "Response
" + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 42, + "name": "Check Commits", + "enforcement": "disabled", + "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", + "allow_downstream_configuration": true + } + ], + "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" + } + } + } + } } } ], - "descriptionHTML": "", "previews": [], + "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.
", "statusCodes": [ { - "httpStatusCode": "204", - "description": "No Content
" + "httpStatusCode": "200", + "description": "OK
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/hooks/{hook_id}/pings", - "title": "Ping a global webhook", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "title": "Get a pre-receive hook for an organization", "category": "enterprise-admin", - "subcategory": "global-webhooks", + "subcategory": "org-pre-receive-hooks", "parameters": [ { - "name": "hook_id", - "description": "The unique identifier of the hook.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pre_receive_hook_id", + "description": "The unique identifier of the pre-receive hook.
", "in": "path", "required": true, "schema": { @@ -167736,7 +212917,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -167744,37 +212925,73 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "hook_id": "HOOK_ID" + "org": "ORG", + "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, "response": { - "statusCode": "204", - "description": "Response
" + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 42, + "name": "Check Commits", + "enforcement": "disabled", + "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", + "allow_downstream_configuration": true + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "enforcement": { + "type": "string" + }, + "configuration_url": { + "type": "string" + }, + "allow_downstream_configuration": { + "type": "boolean" + } + } + } } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "This will trigger a ping event to be sent to the webhook.
", "statusCodes": [ { - "httpStatusCode": "204", - "description": "No Content
" + "httpStatusCode": "200", + "description": "OK
" } ] - } - ], - "ldap": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/admin/ldap/teams/{team_id}/mapping", - "title": "Update LDAP mapping for a team", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "title": "Update pre-receive hook enforcement for an organization", "category": "enterprise-admin", - "subcategory": "ldap", + "subcategory": "org-pre-receive-hooks", "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pre_receive_hook_id", + "description": "The unique identifier of the pre-receive hook.
", "in": "path", "required": true, "schema": { @@ -167785,13 +213002,18 @@ "bodyParameters": [ { "type": "string", - "name": "ldap_dn", + "name": "enforcement", "in": "body", - "description": "The distinguished name (DN) of the LDAP entry to map to a team.
", - "isRequired": true + "description": "The state of enforcement for the hook on this repository.
" + }, + { + "type": "boolean", + "name": "allow_downstream_configuration", + "in": "body", + "description": "Whether repositories can override enforcement.
" } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -167800,10 +213022,12 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + "enforcement": "enabled", + "allow_downstream_configuration": false }, "parameters": { - "team_id": "TEAM_ID" + "org": "ORG", + "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, "response": { @@ -167811,66 +213035,29 @@ "contentType": "application/json", "description": "Response
", "example": { - "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://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null + "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 }, "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "members_url": { + "enforcement": { "type": "string" }, - "repositories_url": { + "configuration_url": { "type": "string" }, - "parent": { - "type": [ - "null" - ] + "allow_downstream_configuration": { + "type": "boolean" } } } @@ -167878,7 +213065,7 @@ } ], "previews": [], - "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.
", + "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
The unique identifier of the team.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pre_receive_hook_id", + "description": "The unique identifier of the pre-receive hook.
", "in": "path", "required": true, "schema": { @@ -167905,7 +213101,7 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -167913,21 +213109,38 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "team_id": "TEAM_ID" + "org": "ORG", + "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { - "status": "queued" + "id": 42, + "name": "Check Commits", + "enforcement": "disabled", + "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", + "allow_downstream_configuration": true }, "schema": { "type": "object", "properties": { - "status": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "enforcement": { + "type": "string" + }, + "configuration_url": { "type": "string" + }, + "allow_downstream_configuration": { + "type": "boolean" } } } @@ -167935,39 +213148,44 @@ } ], "previews": [], - "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.
Removes any overrides for this hook at the org level for this org.
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "Created
" + "httpStatusCode": "200", + "description": "OK
" } ] - }, + } + ], + "orgs": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/ldap/users/{username}/mapping", - "title": "Update LDAP mapping for a user", + "verb": "post", + "requestPath": "/admin/organizations", + "title": "Create an organization", "category": "enterprise-admin", - "subcategory": "ldap", - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], + "subcategory": "orgs", + "parameters": [], "bodyParameters": [ { "type": "string", - "name": "ldap_dn", + "name": "login", "in": "body", - "description": "The distinguished name (DN) of the LDAP entry to map to a team.
", + "description": "The organization's username.
", + "isRequired": true + }, + { + "type": "string", + "name": "admin", + "in": "body", + "description": "The login of the user who will manage this organization.
", "isRequired": true + }, + { + "type": "string", + "name": "profile_name", + "in": "body", + "description": "The organization's display name.
" } ], "enabledForGitHubApps": false, @@ -167979,75 +213197,38 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - }, - "parameters": { - "username": "USERNAME" + "login": "github", + "profile_name": "GitHub, Inc.", + "admin": "monalisaoctocat" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com", - "login": "octocat", + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false, - "name": "monalisa octocat", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "hireable": false, - "bio": "There once was...", - "twitter_username": "monatheoctocat", - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2008-01-14T04:33:35Z", - "private_gists": 81, - "total_private_repos": 100, - "owned_private_repos": 100, - "disk_usage": 10000, - "collaborators": 8, - "two_factor_authentication": true, - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "collaborators": 0 - } + "description": "A great organization" }, "schema": { - "title": "Ldap Private User", - "description": "Ldap Private User", + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "ldap_dn": { - "type": "string" - }, "login": { "type": "string", "examples": [ - "octocat" + "github" ] }, "id": { @@ -168059,320 +213240,83 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "https://api.github.com/orgs/github" ] }, - "followers_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "https://api.github.com/orgs/github/repos" ] }, - "subscriptions_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://api.github.com/orgs/github/events" ] }, - "organizations_url": { + "hooks_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/orgs/github/hooks" ] }, - "repos_url": { + "issues_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/orgs/github/issues" ] }, - "events_url": { + "members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://api.github.com/orgs/github/members{/member}" ] }, - "received_events_url": { + "public_members_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "type": { + "avatar_url": { "type": "string", "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa octocat" - ] - }, - "company": { - "type": [ - "string", - "null" - ], - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": [ - "string", - "null" - ], - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "hireable": { - "type": [ - "boolean", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ], - "examples": [ - "There once was..." + "https://github.com/images/error/octocat_happy.gif" ] }, - "twitter_username": { + "description": { "type": [ "string", "null" ], "examples": [ - "monalisa" - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "private_gists": { - "type": "integer", - "examples": [ - 81 - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "disk_usage": { - "type": "integer", - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": "integer", - "examples": [ - 8 - ] - }, - "two_factor_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" + "A great organization" ] - }, - "suspended_at": { - "type": "string", - "format": "date-time" - }, - "business_plus": { - "type": "boolean" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "login", + "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" + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] } } @@ -168382,22 +213326,22 @@ "previews": [], "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "201", + "description": "Created
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/ldap/users/{username}/sync", - "title": "Sync LDAP mapping for a user", + "verb": "patch", + "requestPath": "/admin/organizations/{org}", + "title": "Update an organization name", "category": "enterprise-admin", - "subcategory": "ldap", + "subcategory": "orgs", "parameters": [ { - "name": "username", - "description": "The handle for the GitHub user account.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -168405,29 +213349,45 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "login", + "in": "body", + "description": "The organization's new name.
", + "isRequired": true + } + ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "login": "the-new-octocats" + }, "parameters": { - "username": "USERNAME" + "org": "ORG" } }, "response": { - "statusCode": "201", + "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { - "status": "queued" + "message": "Job queued to rename organization. It may take a few minutes to complete.", + "url": "https://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.
Created
" + "httpStatusCode": "202", + "description": "Accepted
" } ] } ], - "license": [ + "pre-receive-environments": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/enterprise/settings/license", - "title": "Get license information", + "requestPath": "/admin/pre-receive-environments", + "title": "List pre-receive environments", "category": "enterprise-admin", - "subcategory": "license", - "parameters": [], + "subcategory": "pre-receive-environments", + "parameters": [ + { + "name": "per_page", + "description": "The number of 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": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + }, + "description": "" + } + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -168467,48 +213475,92 @@ "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": { - "seats": 1400, - "seats_used": 1316, - "seats_available": 84, - "kind": "standard", - "days_until_expiration": 365, - "expire_at": "2016/02/06 12:41:52 -0600" - }, + "example": [ + { + "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 + } + } + ], "schema": { - "type": "object", - "properties": { - "seats": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "seats_used": { - "type": "integer" - }, - "seats_available": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" + "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": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } } - ] - }, - "kind": { - "type": "string" - }, - "days_until_expiration": { - "type": "integer" - }, - "expire_at": { - "type": "string" + } } } } @@ -168523,77 +213575,112 @@ "description": "OK
" } ] - } - ], - "management-console": [ + }, { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/configcheck", - "title": "Get the configuration status", + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/admin/pre-receive-environments", + "title": "Create a pre-receive environment", "category": "enterprise-admin", - "subcategory": "management-console", + "subcategory": "pre-receive-environments", "parameters": [], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "The new pre-receive environment's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "image_url", + "in": "body", + "description": "URL from which to download a tarball of this environment.
", + "isRequired": true + } + ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "DevTools Hook Env", + "image_url": "https://my_file_server/path/to/devtools_env.tar.gz" + } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { - "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" - } - ] + "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 + } }, "schema": { "type": "object", "properties": { - "status": { + "id": { + "type": "integer" + }, + "name": { "type": "string" }, - "progress": { - "type": "array", - "items": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "key": { - "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" }, - "required": [ - "status", - "key" - ] + "state": { + "type": "string" + }, + "downloaded_at": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } } } } @@ -168601,23 +213688,33 @@ } } ], + "descriptionHTML": "", "previews": [], - "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 |
OK
" + "httpStatusCode": "201", + "description": "Created
" } ] }, { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/configure", - "title": "Start a configuration process", + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", + "title": "Get a pre-receive environment", "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], + "subcategory": "pre-receive-environments", + "parameters": [ + { + "name": "pre_receive_environment_id", + "description": "The unique identifier of the pre-receive environment.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -168625,91 +213722,211 @@ "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" + } }, "response": { - "statusCode": "202", - "description": "Response
" + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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 + } + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + } + } + } + } } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:
", "statusCodes": [ { - "httpStatusCode": "202", - "description": "Accepted
" + "httpStatusCode": "200", + "description": "OK
" } ] }, { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/maintenance", - "title": "Get the maintenance status", + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", + "title": "Update a pre-receive environment", "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], + "subcategory": "pre-receive-environments", + "parameters": [ + { + "name": "pre_receive_environment_id", + "description": "The unique identifier of the pre-receive environment.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "This pre-receive environment's new name.
" + }, + { + "type": "string", + "name": "image_url", + "in": "body", + "description": "URL from which to download a tarball of this environment.
" + } + ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "DevTools Hook Env", + "image_url": "https://my_file_server/path/to/devtools_env.tar.gz" + }, + "parameters": { + "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" + } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { - "status": "scheduled", - "scheduled_time": "Tuesday, January 22 at 15:34 -0800", - "connection_services": [ - { - "name": "git operations", - "number": 0 - }, - { - "name": "mysql queries", - "number": 233 - }, - { - "name": "aqueduct jobs", - "number": 34 - }, - { - "name": "resque jobs", - "number": 54 - } - ] + "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 + } }, "schema": { "type": "object", "properties": { - "status": { + "id": { + "type": "integer" + }, + "name": { "type": "string" }, - "scheduled_time": { + "image_url": { "type": "string" }, - "connection_services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "number": { - "type": "integer" - } + "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" }, - "required": [ - "name", - "number" - ] + "state": { + "type": "string" + }, + "downloaded_at": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } } } } @@ -168718,95 +213935,127 @@ } ], "previews": [], - "descriptionHTML": "Check your installation's maintenance status:
", + "descriptionHTML": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.
OK
" + }, + { + "httpStatusCode": "422", + "description": "Client Errors
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", + "title": "Delete a pre-receive environment", + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", + "parameters": [ + { + "name": "pre_receive_environment_id", + "description": "The unique identifier of the pre-receive environment.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "If you attempt to delete an environment that cannot be deleted, you will receive a 422 Unprocessable Entity response.
The possible error messages are:
\nOK
" + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "422", + "description": "Client Errors
" } ] }, { - "serverUrl": "http(s)://HOSTNAME", + "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/setup/api/maintenance", - "title": "Enable or disable maintenance mode", + "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", + "title": "Start a pre-receive environment download", "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ + "subcategory": "pre-receive-environments", + "parameters": [ { - "type": "string", - "name": "maintenance", - "in": "body", - "description": "A JSON string with the attributes enabled and when.
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.
The possible values for when are now or any date parseable by mojombo/chronic.
The unique identifier of the pre-receive environment.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/x-www-form-urlencoded", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "maintenance": "{\"enabled\":true, \"when\":\"now\"}" + "parameters": { + "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" } }, "response": { - "statusCode": "200", + "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { - "status": "scheduled", - "scheduled_time": "Tuesday, January 22 at 15:34 -0800", - "connection_services": [ - { - "name": "git operations", - "number": 0 - }, - { - "name": "mysql queries", - "number": 233 - }, - { - "name": "aqueduct jobs", - "number": 34 - }, - { - "name": "resque jobs", - "number": 54 - } - ] + "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", + "state": "not_started", + "downloaded_at": null, + "message": null }, "schema": { "type": "object", "properties": { - "status": { + "url": { "type": "string" }, - "scheduled_time": { + "state": { "type": "string" }, - "connection_services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "number": { - "type": "integer" - } - }, - "required": [ - "name", - "number" - ] - } + "downloaded_at": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] } } } @@ -168814,22 +214063,36 @@ } ], "previews": [], - "descriptionHTML": "Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
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.
If a download cannot be triggered, you will receive a 422 Unprocessable Entity response.
The possible error messages are:
\nOK
" + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "422", + "description": "Client Errors
" } ] }, { - "serverUrl": "http(s)://HOSTNAME", + "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/setup/api/settings", - "title": "Get settings", + "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", + "title": "Get the download status for a pre-receive environment", "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], + "subcategory": "pre-receive-environments", + "parameters": [ + { + "name": "pre_receive_environment_id", + "description": "The unique identifier of the pre-receive environment.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -168837,636 +214100,41 @@ "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" + } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { - "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]" - ] + "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 }, "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": { - "type": [ - "string", - "null" - ] - }, - "auth_mode": { - "type": "string" - }, - "expire_sessions": { - "type": "boolean" - }, - "admin_password": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": [ - "string", - "null" - ] - }, - "key": { - "type": [ - "string", - "null" - ] - } - } - }, - "ldap": { - "type": "object", - "properties": { - "host": { - "type": [ - "string", - "null" - ] - }, - "port": { - "type": "integer" - }, - "base": { - "type": "array", - "items": {} - }, - "uid": { - "type": [ - "string", - "null" - ] - }, - "bind_dn": { - "type": [ - "string", - "null" - ] - }, - "password": { - "type": [ - "string", - "null" - ] - }, - "method": { - "type": "string" - }, - "search_strategy": { - "type": "string" - }, - "user_groups": { - "type": "array", - "items": {} - }, - "admin_group": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": [ - "string", - "null" - ] - }, - "org": { - "type": [ - "string", - "null" - ] - } - } - }, - "profile": { - "type": "object", - "properties": { - "uid": { - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "mail": { - "type": [ - "string", - "null" - ] - }, - "key": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, - "cas": { - "type": "object", - "properties": { - "url": { - "type": [ - "string", - "null" - ] - } - } - }, - "saml": { - "type": "object", - "properties": { - "sso_url": { - "type": [ - "string", - "null" - ] - }, - "certificate": { - "type": [ - "string", - "null" - ] - }, - "certificate_path": { - "type": [ - "string", - "null" - ] - }, - "issuer": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": [ - "string", - "null" - ] - }, - "snmp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "community": { - "type": "string" - } - } - }, - "syslog": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "type": [ - "string", - "null" - ] - }, - "protocol_name": { - "type": "string" - } - } - }, - "assets": { - "type": [ - "string", - "null" - ] - }, - "pages": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "collectd": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "type": [ - "string", - "null" - ] - }, - "port": { - "type": "integer" - }, - "encryption": { - "type": [ - "string", - "null" - ] - }, - "username": { - "type": [ - "string", - "null" - ] - }, - "password": { - "type": [ - "string", - "null" - ] - } - } - }, - "mapping": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "tileserver": { - "type": [ - "string", - "null" - ] - }, - "basemap": { - "type": "string" - }, - "token": { - "type": [ - "string", - "null" - ] - } - } - }, - "load_balancer": { - "type": [ - "string", - "null" - ] - } - } + "url": { + "type": "string" }, - "run_list": { - "type": "array", - "items": { - "type": "string" - } + "state": { + "type": "string" + }, + "downloaded_at": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] } } } @@ -169474,66 +214142,72 @@ } ], "previews": [], - "descriptionHTML": "Gets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote: You cannot retrieve the management console password with the Enterprise administration API.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] - }, + } + ], + "pre-receive-hooks": [ { - "serverUrl": "http(s)://HOSTNAME", - "verb": "put", - "requestPath": "/setup/api/settings", - "title": "Set settings", + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/admin/pre-receive-hooks", + "title": "List pre-receive hooks", "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ + "subcategory": "pre-receive-hooks", + "parameters": [ { - "type": "string", - "name": "settings", - "in": "body", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.
", - "isRequired": true - } - ], - "enabledForGitHubApps": false, - "codeExamples": [ + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { - "key": "204", - "request": { - "contentType": "application/x-www-form-urlencoded", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "settings": "{ \"enterprise\": { \"public_pages\": true }}" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } - } - ], - "previews": [], - "descriptionHTML": "Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.
\nNotes:
\napplication/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"No Content
" + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/settings/authorized-keys", - "title": "Get all authorized SSH keys", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], + ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ @@ -169549,16 +214223,33 @@ "description": "Response
", "example": [ { - "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" - }, - { - "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" + "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 } ], "schema": { @@ -169566,11 +214257,89 @@ "items": { "type": "object", "properties": { - "key": { + "id": { + "type": "integer" + }, + "name": { "type": "string" }, - "pretty-print": { + "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": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + } + } + } + }, + "allow_downstream_configuration": { + "type": "boolean" } } } @@ -169588,20 +214357,53 @@ ] }, { - "serverUrl": "http(s)://HOSTNAME", + "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/setup/api/settings/authorized-keys", - "title": "Add an authorized SSH key", + "requestPath": "/admin/pre-receive-hooks", + "title": "Create a pre-receive hook", "category": "enterprise-admin", - "subcategory": "management-console", + "subcategory": "pre-receive-hooks", "parameters": [], "bodyParameters": [ { - "type": "string", - "name": "authorized_key", + "type": "string", + "name": "name", + "in": "body", + "description": "The name of the hook.
", + "isRequired": true + }, + { + "type": "string", + "name": "script", + "in": "body", + "description": "The script that the hook runs.
", + "isRequired": true + }, + { + "type": "object", + "name": "script_repository", + "in": "body", + "description": "The GitHub repository where the script is kept.
", + "isRequired": true + }, + { + "type": "object", + "name": "environment", + "in": "body", + "description": "The pre-receive environment where the script is executed.
", + "isRequired": true + }, + { + "type": "string", + "name": "enforcement", + "in": "body", + "description": "The state of enforcement for this hook. default: disabled
The public SSH key.
", - "isRequired": true + "description": "Whether enforcement can be overridden at the org or repo level. default: false
Response
", - "example": [ - { - "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" + "example": { + "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" }, - { - "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" + "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 + } }, - { - "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" - } - ], + "allow_downstream_configuration": false + }, "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" + "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": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + } + } } + }, + "allow_downstream_configuration": { + "type": "boolean" } } } } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
The public SSH key.
", - "isRequired": true + "name": "pre_receive_hook_id", + "description": "The unique identifier of the pre-receive hook.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/x-www-form-urlencoded", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" + "parameters": { + "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": [ - { - "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" + "example": { + "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" }, - { - "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" + "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 + } }, - { - "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" - } - ], + "allow_downstream_configuration": false + }, "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" + "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": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + } + } } + }, + "allow_downstream_configuration": { + "type": "boolean" } } } } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
The unique identifier of the pre-receive hook.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], "bodyParameters": [ { "type": "string", - "name": "license", + "name": "name", "in": "body", - "description": "The content of your .ghl license file.
", - "isRequired": true + "description": "The name of the hook.
" }, { "type": "string", - "name": "password", + "name": "script", "in": "body", - "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.
" + "description": "The script that the hook runs.
" + }, + { + "type": "object", + "name": "script_repository", + "in": "body", + "description": "The GitHub repository where the script is kept.
" + }, + { + "type": "object", + "name": "environment", + "in": "body", + "description": "The pre-receive environment where the script is executed.
" }, { "type": "string", - "name": "settings", + "name": "enforcement", + "in": "body", + "description": "The state of enforcement for this hook.
" + }, + { + "type": "boolean", + "name": "allow_downstream_configuration", "in": "body", - "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.
" + "description": "Whether enforcement can be overridden at the org or repo level.
" } ], "enabledForGitHubApps": false, @@ -169767,85 +214786,221 @@ { "key": "default", "request": { - "contentType": "multipart/form-data", + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "license": "@enterprise.ghl", - "password": "secret" + "name": "Check Commits", + "environment": { + "id": 1 + }, + "allow_downstream_configuration": true + }, + "parameters": { + "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, "response": { - "statusCode": "202", - "description": "Response
" + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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 + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + } + } + } + }, + "allow_downstream_configuration": { + "type": "boolean" + } + } + } } } ], + "descriptionHTML": "", "previews": [], - "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.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote: The request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Accepted
" + "httpStatusCode": "200", + "description": "OK
" } ] }, { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/upgrade", - "title": "Upgrade a license", + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", + "title": "Delete a pre-receive hook", "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ + "subcategory": "pre-receive-hooks", + "parameters": [ { - "type": "string", - "name": "license", - "in": "body", - "description": "The content of your new .ghl license file.
" + "name": "pre_receive_hook_id", + "description": "The unique identifier of the pre-receive hook.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], + "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { - "contentType": "multipart/form-data", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "license": "@enterprise.ghl" + "parameters": { + "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, "response": { - "statusCode": "202", + "statusCode": "204", "description": "Response
" } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "This API upgrades your license and also triggers the configuration process.
\nNote: The request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Accepted
" + "httpStatusCode": "204", + "description": "No Content
" } ] } ], - "org-pre-receive-hooks": [ + "repo-pre-receive-hooks": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "title": "List pre-receive hooks for an organization", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "title": "List pre-receive hooks for a repository", "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks", + "subcategory": "repo-pre-receive-hooks", "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -169886,7 +215041,6 @@ }, { "name": "sort", - "description": "The sort order for the response collection.
", "in": "query", "required": false, "schema": { @@ -169897,7 +215051,8 @@ "name" ], "default": "created" - } + }, + "description": "" } ], "bodyParameters": [], @@ -169909,7 +215064,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -169921,8 +215077,7 @@ "id": 42, "name": "Check Commits", "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", - "allow_downstream_configuration": true + "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" } ], "schema": { @@ -169941,9 +215096,6 @@ }, "configuration_url": { "type": "string" - }, - "allow_downstream_configuration": { - "type": "boolean" } } } @@ -169952,7 +215104,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -169963,14 +215115,23 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Get a pre-receive hook for an organization", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "title": "Get a pre-receive hook for a repository", "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks", + "subcategory": "repo-pre-receive-hooks", "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -169996,7 +215157,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", + "owner": "OWNER", + "repo": "REPO", "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, @@ -170008,8 +215170,7 @@ "id": 42, "name": "Check Commits", "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", - "allow_downstream_configuration": true + "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" }, "schema": { "type": "object", @@ -170025,9 +215186,6 @@ }, "configuration_url": { "type": "string" - }, - "allow_downstream_configuration": { - "type": "boolean" } } } @@ -170046,14 +215204,23 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Update pre-receive hook enforcement for an organization", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "title": "Update pre-receive hook enforcement for a repository", "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks", + "subcategory": "repo-pre-receive-hooks", "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -170075,13 +215242,12 @@ "type": "string", "name": "enforcement", "in": "body", - "description": "The state of enforcement for the hook on this repository.
" - }, - { - "type": "boolean", - "name": "allow_downstream_configuration", - "in": "body", - "description": "Whether repositories can override enforcement.
" + "description": "The state of enforcement for the hook on this repository.
", + "enum": [ + "enabled", + "disabled", + "testing" + ] } ], "enabledForGitHubApps": true, @@ -170093,11 +215259,11 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "enforcement": "enabled", - "allow_downstream_configuration": false + "enforcement": "enabled" }, "parameters": { - "org": "ORG", + "owner": "OWNER", + "repo": "REPO", "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, @@ -170109,8 +215275,7 @@ "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 + "configuration_url": "https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42" }, "schema": { "type": "object", @@ -170126,9 +215291,6 @@ }, "configuration_url": { "type": "string" - }, - "allow_downstream_configuration": { - "type": "boolean" } } } @@ -170136,7 +215298,7 @@ } ], "previews": [], - "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
The organization name. The name is not case sensitive.
", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -170180,20 +215351,20 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "org": "ORG", + "owner": "OWNER", + "repo": "REPO", "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response
", + "description": "Responds with effective values inherited from owner and/or global level.
", "example": { "id": 42, "name": "Check Commits", "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", - "allow_downstream_configuration": true + "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" }, "schema": { "type": "object", @@ -170209,9 +215380,6 @@ }, "configuration_url": { "type": "string" - }, - "allow_downstream_configuration": { - "type": "boolean" } } } @@ -170219,825 +215387,2005 @@ } ], "previews": [], - "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
", + "descriptionHTML": "Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", "statusCodes": [ { "httpStatusCode": "200", - "description": "OK
" + "description": "Responds with effective values inherited from owner and/or global level.
" } ] } ], - "orgs": [ + "scim": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/organizations", - "title": "Create an organization", + "verb": "get", + "requestPath": "/scim/v2/Groups", + "title": "List provisioned SCIM groups for an enterprise", "category": "enterprise-admin", - "subcategory": "orgs", - "parameters": [], - "bodyParameters": [ + "subcategory": "scim", + "parameters": [ { - "type": "string", - "name": "login", - "in": "body", - "description": "The organization's username.
", - "isRequired": true + "name": "filter", + "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are externalId, id, and displayName. For example, ?filter=\"externalId eq '9138790-10932-109120392-12321'\".
The login of the user who will manage this organization.
", - "isRequired": true + "name": "excludedAttributes", + "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "members" + ] + } }, { - "type": "string", - "name": "profile_name", - "in": "body", - "description": "The organization's display name.
" + "name": "startIndex", + "description": "Used for pagination: the starting index of the first result to return when paginating through values.
", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 1, + "format": "int32", + "examples": [ + 1 + ] + } + }, + { + "name": "count", + "description": "Used for pagination: the number of results to return per page.
", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 30, + "format": "int32", + "examples": [ + 1 + ] + } } ], - "enabledForGitHubApps": false, + "bodyParameters": [], + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "login": "github", - "profile_name": "GitHub, Inc.", - "admin": "monalisaoctocat" - } + "acceptHeader": "application/vnd.github.v3+json" }, "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", + "statusCode": "200", + "contentType": "application/scim+json", + "description": "Success, either groups were found or not found
", "example": { - "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" + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "totalResults": 1, + "Resources": [ + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "id": "927fa2c08dcb4a7fae9e", + "displayName": "Engineering", + "members": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ], + "meta": { + "resourceType": "Group", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + } + } + ], + "startIndex": 1, + "itemsPerPage": 20 }, "schema": { - "title": "Organization Simple", - "description": "A GitHub organization.", "type": "object", + "required": [ + "schemas", + "totalResults", + "Resources", + "startIndex", + "itemsPerPage" + ], "properties": { - "login": { - "type": "string", + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the list SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ] + }, "examples": [ - "github" + "urn:ietf:params:scim:api:messages:2.0:ListResponse" ] }, - "id": { + "totalResults": { "type": "integer", + "description": "Number of results found", "examples": [ 1 ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] + "Resources": { + "type": "array", + "description": "Information about each provisioned group.", + "items": { + "allOf": [ + { + "type": "object", + "required": [ + "schemas" + ], + "properties": { + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:Group", + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159" + ] + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for a security group.", + "examples": [ + "Engineering" + ] + }, + "members": { + "type": "array", + "description": "The group members.", + "items": { + "type": "object", + "required": [ + "value", + "$ref" + ], + "properties": { + "value": { + "type": "string", + "description": "The local unique identifier for the member", + "examples": [ + "23a35c27-23d3-4c03-b4c5-6443c09e7173" + ] + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string", + "description": "The display name associated with the member", + "examples": [ + "Monalisa Octocat" + ] + } + } + } + } + } + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the group object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "The security group members.", + "examples": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ] + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } + } + } + } + ] + } }, - "avatar_url": { - "type": "string", + "startIndex": { + "type": "integer", + "description": "A starting index for the returned page", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + 1 ] }, - "description": { - "type": [ - "string", - "null" - ], + "itemsPerPage": { + "type": "integer", + "description": "Number of objects per page", "examples": [ - "A great organization" + 20 ] } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Created
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/organizations/{org}", - "title": "Update an organization name", - "category": "enterprise-admin", - "subcategory": "orgs", - "parameters": [ + "httpStatusCode": "200", + "description": "Success, either groups were found or not found
" + }, { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } - ], + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/scim/v2/Groups", + "title": "Provision a SCIM enterprise group", + "category": "enterprise-admin", + "subcategory": "scim", + "parameters": [], "bodyParameters": [ + { + "type": "array of strings", + "name": "schemas", + "in": "body", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.
", + "isRequired": true + }, { "type": "string", - "name": "login", + "name": "externalId", "in": "body", - "description": "The organization's new name.
", + "description": "A unique identifier for the resource as defined by the provisioning client.
", + "isRequired": true + }, + { + "type": "string", + "name": "displayName", + "in": "body", + "description": "A human-readable name for a security group.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "members", + "in": "body", + "description": "The group members.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "value", + "description": "The local unique identifier for the member
", + "isRequired": true + }, + { + "type": "string", + "name": "displayName", + "description": "The display name associated with the member
", + "isRequired": true + } + ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "group", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "login": "the-new-octocats" - }, - "parameters": { - "org": "ORG" + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "displayName": "Engineering" } }, "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "Response
", + "statusCode": "201", + "contentType": "application/scim+json", + "description": "Group has been created
", "example": { - "message": "Job queued to rename organization. It may take a few minutes to complete.", - "url": "https://Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Accepted
" + "httpStatusCode": "201", + "description": "Group has been created
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "409", + "description": "Duplicate record detected
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] - } - ], - "pre-receive-environments": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/admin/pre-receive-environments", - "title": "List pre-receive environments", + "requestPath": "/scim/v2/Groups/{scim_group_id}", + "title": "Get SCIM provisioning information for an enterprise group", "category": "enterprise-admin", - "subcategory": "pre-receive-environments", + "subcategory": "scim", "parameters": [ { - "name": "per_page", - "description": "The number of 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": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, + "name": "scim_group_id", + "description": "A unique identifier of the SCIM group.
", + "in": "path", + "required": true, "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] } }, { - "name": "sort", + "name": "excludedAttributes", + "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
", "in": "query", "required": false, "schema": { "type": "string", - "enum": [ - "created", - "updated", - "name" - ], - "default": "created" - }, - "description": "" + "examples": [ + "members" + ] + } } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "scim_group_id": "SCIM_GROUP_ID" + } }, "response": { "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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 + "contentType": "application/scim+json", + "description": "Success, a group was found
", + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "displayName": "Engineering", + "members": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" } + ], + "meta": { + "resourceType": "Group", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" } - ], + }, "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": { - "type": [ - "string", - "null" + "allOf": [ + { + "type": "object", + "required": [ + "schemas" + ], + "properties": { + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:Group", + "urn:ietf:params:scim:api:messages:2.0:ListResponse" ] }, - "message": { - "type": [ - "string", - "null" - ] + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159" + ] + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for a security group.", + "examples": [ + "Engineering" + ] + }, + "members": { + "type": "array", + "description": "The group members.", + "items": { + "type": "object", + "required": [ + "value", + "$ref" + ], + "properties": { + "value": { + "type": "string", + "description": "The local unique identifier for the member", + "examples": [ + "23a35c27-23d3-4c03-b4c5-6443c09e7173" + ] + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string", + "description": "The display name associated with the member", + "examples": [ + "Monalisa Octocat" + ] + } + } + } + } + } + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the group object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "The security group members.", + "examples": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ] + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } } } } } - } + ] } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nGets information about a SCIM group.
", "statusCodes": [ { "httpStatusCode": "200", - "description": "OK
" + "description": "Success, a group was found
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/pre-receive-environments", - "title": "Create a pre-receive environment", + "verb": "put", + "requestPath": "/scim/v2/Groups/{scim_group_id}", + "title": "Set SCIM information for a provisioned enterprise group", "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [], + "subcategory": "scim", + "parameters": [ + { + "name": "scim_group_id", + "description": "A unique identifier of the SCIM group.
", + "in": "path", + "required": true, + "schema": { + "type": "string", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + } + } + ], "bodyParameters": [ + { + "type": "array of strings", + "name": "schemas", + "in": "body", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.
", + "isRequired": true + }, { "type": "string", - "name": "name", + "name": "externalId", "in": "body", - "description": "The new pre-receive environment's name.
", + "description": "A unique identifier for the resource as defined by the provisioning client.
", "isRequired": true }, { "type": "string", - "name": "image_url", + "name": "displayName", "in": "body", - "description": "URL from which to download a tarball of this environment.
", + "description": "A human-readable name for a security group.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "members", + "in": "body", + "description": "The group members.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "value", + "description": "The local unique identifier for the member
", + "isRequired": true + }, + { + "type": "string", + "name": "displayName", + "description": "The display name associated with the member
", + "isRequired": true + } + ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "group", "request": { "contentType": "application/json", - "description": "Example", + "description": "Group", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz" + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "displayName": "Engineering" + }, + "parameters": { + "scim_group_id": "SCIM_GROUP_ID" } }, "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", + "statusCode": "200", + "contentType": "application/scim+json", + "description": "Group was updated
", "example": { - "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 + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "displayName": "Engineering", + "members": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ], + "meta": { + "resourceType": "Group", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" } }, "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": { + "allOf": [ + { "type": "object", + "required": [ + "schemas" + ], "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:Group", + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] }, - "downloaded_at": { + "externalId": { "type": [ "string", "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159" ] }, - "message": { + "displayName": { "type": [ "string", "null" + ], + "description": "A human-readable name for a security group.", + "examples": [ + "Engineering" ] + }, + "members": { + "type": "array", + "description": "The group members.", + "items": { + "type": "object", + "required": [ + "value", + "$ref" + ], + "properties": { + "value": { + "type": "string", + "description": "The local unique identifier for the member", + "examples": [ + "23a35c27-23d3-4c03-b4c5-6443c09e7173" + ] + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string", + "description": "The display name associated with the member", + "examples": [ + "Monalisa Octocat" + ] + } + } + } + } + } + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the group object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "The security group members.", + "examples": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ] + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } } } } - } + ] } } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Created
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "title": "Get a pre-receive environment", - "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ + }, { - "key": "default", + "key": "groupWithMembers", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Group with member", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "displayName": "Engineering", + "members": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ] + }, "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" + "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "200", - "contentType": "application/json", - "description": "Response
", + "contentType": "application/scim+json", + "description": "Group was updated
", "example": { - "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 + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "displayName": "Engineering", + "members": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ], + "meta": { + "resourceType": "Group", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" } }, "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": { + "allOf": [ + { "type": "object", + "required": [ + "schemas" + ], "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:Group", + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] }, - "downloaded_at": { + "externalId": { "type": [ "string", "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159" ] }, - "message": { + "displayName": { "type": [ "string", "null" + ], + "description": "A human-readable name for a security group.", + "examples": [ + "Engineering" + ] + }, + "members": { + "type": "array", + "description": "The group members.", + "items": { + "type": "object", + "required": [ + "value", + "$ref" + ], + "properties": { + "value": { + "type": "string", + "description": "The local unique identifier for the member", + "examples": [ + "23a35c27-23d3-4c03-b4c5-6443c09e7173" + ] + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string", + "description": "The display name associated with the member", + "examples": [ + "Monalisa Octocat" + ] + } + } + } + } + } + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the group object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" ] + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "The security group members.", + "examples": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ] + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } } } } - } + ] } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", - "description": "OK
" + "description": "Group was updated
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "409", + "description": "Duplicate record detected
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "title": "Update a pre-receive environment", + "requestPath": "/scim/v2/Groups/{scim_group_id}", + "title": "Update an attribute for a SCIM enterprise group", "category": "enterprise-admin", - "subcategory": "pre-receive-environments", + "subcategory": "scim", "parameters": [ { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.
", + "name": "scim_group_id", + "description": "A unique identifier of the SCIM group.
", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] } } ], "bodyParameters": [ { - "type": "string", - "name": "name", + "type": "array of objects", + "name": "Operations", "in": "body", - "description": "This pre-receive environment's new name.
" + "description": "patch operations list
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "op", + "description": "", + "isRequired": true, + "enum": [ + "add", + "replace", + "remove" + ] + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "string", + "name": "value", + "description": "Corresponding 'value' of that field specified by 'path'
" + } + ] }, { - "type": "string", - "name": "image_url", + "type": "array of strings", + "name": "schemas", "in": "body", - "description": "URL from which to download a tarball of this environment.
" + "description": "", + "isRequired": true } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "updateGroup", + "response": { + "statusCode": "200", + "contentType": "application/scim+json", + "description": "Success, group was updated
", + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "displayName": "Engineering", + "members": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ], + "meta": { + "resourceType": "Group", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + } + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "schemas" + ], + "properties": { + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:Group", + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159" + ] + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for a security group.", + "examples": [ + "Engineering" + ] + }, + "members": { + "type": "array", + "description": "The group members.", + "items": { + "type": "object", + "required": [ + "value", + "$ref" + ], + "properties": { + "value": { + "type": "string", + "description": "The local unique identifier for the member", + "examples": [ + "23a35c27-23d3-4c03-b4c5-6443c09e7173" + ] + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string", + "description": "The display name associated with the member", + "examples": [ + "Monalisa Octocat" + ] + } + } + } + } + } + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the group object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "The security group members.", + "examples": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ] + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } + } + } + } + ] + } + }, "request": { "contentType": "application/json", - "description": "Example", + "description": "Update Group", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "DevTools Hook Env", - "image_url": "https://my_file_server/path/to/devtools_env.tar.gz" + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "replace", + "path": "displayName", + "value": "Employees" + } + ] }, "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" + "scim_group_id": "SCIM_GROUP_ID" } - }, + } + }, + { + "key": "addMembers", "response": { "statusCode": "200", - "contentType": "application/json", - "description": "Response
", + "contentType": "application/scim+json", + "description": "Success, group was updated
", "example": { - "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 + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", + "displayName": "Engineering", + "members": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } + ], + "meta": { + "resourceType": "Group", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" } }, "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": { + "allOf": [ + { "type": "object", + "required": [ + "schemas" + ], "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:Group", + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] }, - "downloaded_at": { + "externalId": { "type": [ "string", "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159" ] }, - "message": { + "displayName": { "type": [ "string", "null" + ], + "description": "A human-readable name for a security group.", + "examples": [ + "Engineering" + ] + }, + "members": { + "type": "array", + "description": "The group members.", + "items": { + "type": "object", + "required": [ + "value", + "$ref" + ], + "properties": { + "value": { + "type": "string", + "description": "The local unique identifier for the member", + "examples": [ + "23a35c27-23d3-4c03-b4c5-6443c09e7173" + ] + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string", + "description": "The display name associated with the member", + "examples": [ + "Monalisa Octocat" + ] + } + } + } + } + } + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the group object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "The security group members.", + "examples": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745", + "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + "displayName": "User 1" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + "displayName": "User 2" + } ] + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } } } } - } + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Add Members", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "add", + "path": "members", + "value": [ + { + "value": "879db59-3bdf-4490-ad68-ab880a2694745" + }, + { + "value": "0db508eb-91e2-46e4-809c-30dcbda0c685" + } + ] + } + ] + }, + "parameters": { + "scim_group_id": "SCIM_GROUP_ID" } } } ], "previews": [], - "descriptionHTML": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
OK
" + "description": "Success, group was updated
" }, { - "httpStatusCode": "422", - "description": "Client Errors
" + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "409", + "description": "Duplicate record detected
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "title": "Delete a pre-receive environment", + "requestPath": "/scim/v2/Groups/{scim_group_id}", + "title": "Delete a SCIM group from an enterprise", "category": "enterprise-admin", - "subcategory": "pre-receive-environments", + "subcategory": "scim", "parameters": [ { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.
", + "name": "scim_group_id", + "description": "A unique identifier of the SCIM group.
", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] } } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -171045,87 +217393,459 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" + "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "204", - "description": "Response
" + "description": "Group was deleted, no content
" } } ], "previews": [], - "descriptionHTML": "If you attempt to delete an environment that cannot be deleted, you will receive a 422 Unprocessable Entity response.
The possible error messages are:
\nNote: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", - "description": "No Content
" + "description": "Group was deleted, no content
" }, { - "httpStatusCode": "422", - "description": "Client Errors
" + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "title": "Start a pre-receive environment download", + "verb": "get", + "requestPath": "/scim/v2/Users", + "title": "List SCIM provisioned identities for an enterprise", "category": "enterprise-admin", - "subcategory": "pre-receive-environments", + "subcategory": "scim", "parameters": [ { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.
", - "in": "path", - "required": true, + "name": "filter", + "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are userName, externalId, id, and displayName. For example, ?filter=\"externalId eq '9138790-10932-109120392-12321'\".
Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "members" + ] + } + }, + { + "name": "startIndex", + "description": "Used for pagination: the starting index of the first result to return when paginating through values.
", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 1, + "format": "int32", + "examples": [ + 1 + ] + } + }, + { + "name": "count", + "description": "Used for pagination: the number of results to return per page.
", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 30, + "format": "int32", + "examples": [ + 1 + ] } } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" - } + "acceptHeader": "application/vnd.github.v3+json" }, "response": { - "statusCode": "202", - "contentType": "application/json", - "description": "Response
", + "statusCode": "200", + "contentType": "application/scim+json", + "description": "Success, either users were found or not found
", "example": { - "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", - "state": "not_started", - "downloaded_at": null, - "message": null + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "totalResults": 1, + "Resources": [ + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "externalId": "E012345", + "id": "7fce0092-d52e-4f76-b727-3955bd72c939", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" + }, + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true + } + ], + "roles": [ + { + "value": "User", + "primary": false + } + ] + } + ], + "startIndex": 1, + "itemsPerPage": 20 }, "schema": { "type": "object", + "required": [ + "schemas", + "totalResults", + "Resources", + "startIndex", + "itemsPerPage" + ], "properties": { - "url": { - "type": "string" + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the list SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ] + }, + "examples": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ] }, - "state": { - "type": "string" + "totalResults": { + "type": "integer", + "description": "Number of results found", + "examples": [ + 1 + ] }, - "downloaded_at": { - "type": [ - "string", - "null" + "Resources": { + "type": "array", + "description": "Information about each provisioned account.", + "items": { + "allOf": [ + { + "type": "object", + "required": [ + "schemas", + "active", + "emails" + ], + "properties": { + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "E012345" + ] + }, + "active": { + "type": "boolean", + "description": "Whether the user active in the IdP.", + "examples": [ + true + ] + }, + "userName": { + "type": "string", + "description": "The username for the user.", + "examples": [ + "E012345" + ] + }, + "name": { + "type": "object", + "properties": { + "formatted": { + "type": "string", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "examples": [ + "Ms. Mona Lisa Octocat" + ] + }, + "familyName": { + "type": "string", + "description": "The family name of the user.", + "examples": [ + "Octocat" + ] + }, + "givenName": { + "type": "string", + "description": "The given name of the user.", + "examples": [ + "Mona" + ] + }, + "middleName": { + "type": "string", + "description": "The middle name(s) of the user.", + "examples": [ + "Lisa" + ] + } + } + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for the user.", + "examples": [ + "Mona Lisa" + ] + }, + "emails": { + "type": "array", + "description": "The emails for the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "The email address.", + "examples": [ + "mlisa@example.com" + ] + }, + "type": { + "type": "string", + "description": "The type of email address.", + "examples": [ + "work" + ] + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address.", + "examples": [ + true + ] + } + } + } + }, + "roles": { + "type": "array", + "description": "The roles assigned to the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "display": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "string", + "description": "The role value representing a user role in GitHub.", + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "examples": [ + "user" + ] + }, + "primary": { + "type": "boolean", + "description": "Is the role a primary role for the user.", + "examples": [ + false + ] + } + } + } + } + } + }, + { + "type": "object", + "required": [ + "id", + "meta" + ], + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the user object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "Provisioned SCIM groups that the user is a member of." + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } + } + } + } + ] + } + }, + "startIndex": { + "type": "integer", + "description": "A starting index for the returned page", + "examples": [ + 1 ] }, - "message": { - "type": [ - "string", - "null" + "itemsPerPage": { + "type": "integer", + "description": "Number of objects per page", + "examples": [ + 20 ] } } @@ -171134,1089 +217854,2791 @@ } ], "previews": [], - "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.
If a download cannot be triggered, you will receive a 422 Unprocessable Entity response.
The possible error messages are:
\nNote: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
You can improve query search time by using the excludedAttributes query parameter with a value of groups to exclude groups from the response.
Accepted
" + "httpStatusCode": "200", + "description": "Success, either users were found or not found
" }, { - "httpStatusCode": "422", - "description": "Client Errors
" + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "title": "Get the download status for a pre-receive environment", + "verb": "post", + "requestPath": "/scim/v2/Users", + "title": "Provision a SCIM enterprise user", "category": "enterprise-admin", - "subcategory": "pre-receive-environments", - "parameters": [ + "subcategory": "scim", + "parameters": [], + "bodyParameters": [ { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } + "type": "array of strings", + "name": "schemas", + "in": "body", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.
", + "isRequired": true + }, + { + "type": "string", + "name": "externalId", + "in": "body", + "description": "A unique identifier for the resource as defined by the provisioning client.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "active", + "in": "body", + "description": "Whether the user active in the IdP.
", + "isRequired": true + }, + { + "type": "string", + "name": "userName", + "in": "body", + "description": "The username for the user.
", + "isRequired": true + }, + { + "type": "object", + "name": "name", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "formatted", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
" + }, + { + "type": "string", + "name": "familyName", + "description": "The family name of the user.
", + "isRequired": true + }, + { + "type": "string", + "name": "givenName", + "description": "The given name of the user.
", + "isRequired": true + }, + { + "type": "string", + "name": "middleName", + "description": "The middle name(s) of the user.
" + } + ] + }, + { + "type": "string", + "name": "displayName", + "in": "body", + "description": "A human-readable name for the user.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "emails", + "in": "body", + "description": "The emails for the user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "value", + "description": "The email address.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of email address.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "primary", + "description": "Whether this email address is the primary address.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "roles", + "in": "body", + "description": "The roles assigned to the user.
", + "childParamsGroups": [ + { + "type": "string", + "name": "display", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "value", + "description": "The role value representing a user role in GitHub.
", + "isRequired": true, + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ] + }, + { + "type": "boolean", + "name": "primary", + "description": "Is the role a primary role for the user.
" + } + ] } ], - "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "user", "request": { - "description": "Example", + "contentType": "application/json", + "description": "User", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" + "bodyParameters": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" + }, + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true + } + ], + "roles": [ + { + "value": "User", + "primary": false + } + ] } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", + "statusCode": "201", + "contentType": "application/scim+json", + "description": "User has been created
", "example": { - "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 + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "7fce0092-d52e-4f76-b727-3955bd72c939", + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" + }, + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true + } + ], + "roles": [ + { + "value": "User", + "primary": false + } + ], + "meta": { + "resourceType": "User", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" + } }, "schema": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" + "allOf": [ + { + "type": "object", + "required": [ + "schemas", + "active", + "emails" + ], + "properties": { + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "E012345" + ] + }, + "active": { + "type": "boolean", + "description": "Whether the user active in the IdP.", + "examples": [ + true + ] + }, + "userName": { + "type": "string", + "description": "The username for the user.", + "examples": [ + "E012345" + ] + }, + "name": { + "type": "object", + "properties": { + "formatted": { + "type": "string", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "examples": [ + "Ms. Mona Lisa Octocat" + ] + }, + "familyName": { + "type": "string", + "description": "The family name of the user.", + "examples": [ + "Octocat" + ] + }, + "givenName": { + "type": "string", + "description": "The given name of the user.", + "examples": [ + "Mona" + ] + }, + "middleName": { + "type": "string", + "description": "The middle name(s) of the user.", + "examples": [ + "Lisa" + ] + } + } + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for the user.", + "examples": [ + "Mona Lisa" + ] + }, + "emails": { + "type": "array", + "description": "The emails for the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "The email address.", + "examples": [ + "mlisa@example.com" + ] + }, + "type": { + "type": "string", + "description": "The type of email address.", + "examples": [ + "work" + ] + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address.", + "examples": [ + true + ] + } + } + } + }, + "roles": { + "type": "array", + "description": "The roles assigned to the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "display": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "string", + "description": "The role value representing a user role in GitHub.", + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "examples": [ + "user" + ] + }, + "primary": { + "type": "boolean", + "description": "Is the role a primary role for the user.", + "examples": [ + false + ] + } + } + } + } + } }, - "downloaded_at": { - "type": [ - "string", - "null" - ] + { + "type": "object", + "required": [ + "id", + "meta" + ], + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the user object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "Provisioned SCIM groups that the user is a member of." + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } + } + } + } + ] + } + } + }, + { + "key": "enterpriseOwner", + "request": { + "contentType": "application/json", + "description": "Enterprise Owner", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" + }, + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true + } + ], + "roles": [ + { + "value": "Enterprise Owner", + "primary": false + } + ] + } + }, + "response": { + "statusCode": "201", + "contentType": "application/scim+json", + "description": "User has been created
", + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "7fce0092-d52e-4f76-b727-3955bd72c939", + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" + }, + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true + } + ], + "roles": [ + { + "value": "User", + "primary": false + } + ], + "meta": { + "resourceType": "User", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" + } + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "schemas", + "active", + "emails" + ], + "properties": { + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "E012345" + ] + }, + "active": { + "type": "boolean", + "description": "Whether the user active in the IdP.", + "examples": [ + true + ] + }, + "userName": { + "type": "string", + "description": "The username for the user.", + "examples": [ + "E012345" + ] + }, + "name": { + "type": "object", + "properties": { + "formatted": { + "type": "string", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "examples": [ + "Ms. Mona Lisa Octocat" + ] + }, + "familyName": { + "type": "string", + "description": "The family name of the user.", + "examples": [ + "Octocat" + ] + }, + "givenName": { + "type": "string", + "description": "The given name of the user.", + "examples": [ + "Mona" + ] + }, + "middleName": { + "type": "string", + "description": "The middle name(s) of the user.", + "examples": [ + "Lisa" + ] + } + } + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for the user.", + "examples": [ + "Mona Lisa" + ] + }, + "emails": { + "type": "array", + "description": "The emails for the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "The email address.", + "examples": [ + "mlisa@example.com" + ] + }, + "type": { + "type": "string", + "description": "The type of email address.", + "examples": [ + "work" + ] + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address.", + "examples": [ + true + ] + } + } + } + }, + "roles": { + "type": "array", + "description": "The roles assigned to the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "display": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "string", + "description": "The role value representing a user role in GitHub.", + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "examples": [ + "user" + ] + }, + "primary": { + "type": "boolean", + "description": "Is the role a primary role for the user.", + "examples": [ + false + ] + } + } + } + } + } }, - "message": { - "type": [ - "string", - "null" - ] + { + "type": "object", + "required": [ + "id", + "meta" + ], + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the user object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "Provisioned SCIM groups that the user is a member of." + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } + } + } } - } + ] } } } ], "previews": [], - "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.
", + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
OK
" + "httpStatusCode": "201", + "description": "User has been created
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "409", + "description": "Duplicate record detected
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] - } - ], - "pre-receive-hooks": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/admin/pre-receive-hooks", - "title": "List pre-receive hooks", + "requestPath": "/scim/v2/Users/{scim_user_id}", + "title": "Get SCIM provisioning information for an enterprise user", "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", + "subcategory": "scim", "parameters": [ { - "name": "per_page", - "description": "The number of 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": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.
", - "in": "query", - "required": false, + "name": "scim_user_id", + "description": "The unique identifier of the SCIM user.
", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "name" - ], - "default": "created" + "type": "string" } } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "scim_user_id": "SCIM_USER_ID" + } }, "response": { "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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 + "contentType": "application/scim+json", + "description": "Success, a user was found
", + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "7fce0092-d52e-4f76-b727-3955bd72c939", + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" + }, + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true + } + ], + "roles": [ + { + "value": "User", + "primary": false + } + ], + "meta": { + "resourceType": "User", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" } - ], + }, "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" + "allOf": [ + { + "type": "object", + "required": [ + "schemas", + "active", + "emails" + ], + "properties": { + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] }, - "html_url": { - "type": "string" + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "E012345" + ] + }, + "active": { + "type": "boolean", + "description": "Whether the user active in the IdP.", + "examples": [ + true + ] + }, + "userName": { + "type": "string", + "description": "The username for the user.", + "examples": [ + "E012345" + ] + }, + "name": { + "type": "object", + "properties": { + "formatted": { + "type": "string", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "examples": [ + "Ms. Mona Lisa Octocat" + ] + }, + "familyName": { + "type": "string", + "description": "The family name of the user.", + "examples": [ + "Octocat" + ] + }, + "givenName": { + "type": "string", + "description": "The given name of the user.", + "examples": [ + "Mona" + ] + }, + "middleName": { + "type": "string", + "description": "The middle name(s) of the user.", + "examples": [ + "Lisa" + ] + } } - } - }, - "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": { + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for the user.", + "examples": [ + "Mona Lisa" + ] + }, + "emails": { + "type": "array", + "description": "The emails for the user.", + "items": { "type": "object", + "required": [ + "value" + ], "properties": { - "url": { + "value": { + "type": "string", + "description": "The email address.", + "examples": [ + "mlisa@example.com" + ] + }, + "type": { + "type": "string", + "description": "The type of email address.", + "examples": [ + "work" + ] + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address.", + "examples": [ + true + ] + } + } + } + }, + "roles": { + "type": "array", + "description": "The roles assigned to the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "display": { "type": "string" }, - "state": { + "type": { "type": "string" }, - "downloaded_at": { - "type": [ - "string", - "null" + "value": { + "type": "string", + "description": "The role value representing a user role in GitHub.", + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "examples": [ + "user" ] }, - "message": { - "type": [ - "string", - "null" + "primary": { + "type": "boolean", + "description": "Is the role a primary role for the user.", + "examples": [ + false ] } } } } - }, - "allow_downstream_configuration": { - "type": "boolean" + } + }, + { + "type": "object", + "required": [ + "id", + "meta" + ], + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the user object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "Provisioned SCIM groups that the user is a member of." + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } + } } } - } + ] } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nGets information about a SCIM user.
", "statusCodes": [ { "httpStatusCode": "200", - "description": "OK
" + "description": "Success, a user was found
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/admin/pre-receive-hooks", - "title": "Create a pre-receive hook", + "verb": "put", + "requestPath": "/scim/v2/Users/{scim_user_id}", + "title": "Set SCIM information for a provisioned enterprise user", "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", - "parameters": [], + "subcategory": "scim", + "parameters": [ + { + "name": "scim_user_id", + "description": "The unique identifier of the SCIM user.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "bodyParameters": [ { - "type": "string", - "name": "name", + "type": "array of strings", + "name": "schemas", "in": "body", - "description": "The name of the hook.
", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.
", "isRequired": true }, { "type": "string", - "name": "script", + "name": "externalId", "in": "body", - "description": "The script that the hook runs.
", + "description": "A unique identifier for the resource as defined by the provisioning client.
", "isRequired": true }, { - "type": "object", - "name": "script_repository", + "type": "boolean", + "name": "active", "in": "body", - "description": "The GitHub repository where the script is kept.
", + "description": "Whether the user active in the IdP.
", "isRequired": true }, { - "type": "object", - "name": "environment", + "type": "string", + "name": "userName", "in": "body", - "description": "The pre-receive environment where the script is executed.
", + "description": "The username for the user.
", "isRequired": true }, + { + "type": "object", + "name": "name", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "formatted", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
" + }, + { + "type": "string", + "name": "familyName", + "description": "The family name of the user.
", + "isRequired": true + }, + { + "type": "string", + "name": "givenName", + "description": "The given name of the user.
", + "isRequired": true + }, + { + "type": "string", + "name": "middleName", + "description": "The middle name(s) of the user.
" + } + ] + }, { "type": "string", - "name": "enforcement", + "name": "displayName", "in": "body", - "description": "The state of enforcement for this hook. default: disabled
A human-readable name for the user.
", + "isRequired": true }, { - "type": "boolean", - "name": "allow_downstream_configuration", + "type": "array of objects", + "name": "emails", "in": "body", - "description": "Whether enforcement can be overridden at the org or repo level. default: false
The emails for the user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "value", + "description": "The email address.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of email address.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "primary", + "description": "Whether this email address is the primary address.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "roles", + "in": "body", + "description": "The roles assigned to the user.
", + "childParamsGroups": [ + { + "type": "string", + "name": "display", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "value", + "description": "The role value representing a user role in GitHub.
", + "isRequired": true, + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ] + }, + { + "type": "boolean", + "name": "primary", + "description": "Is the role a primary role for the user.
" + } + ] } ], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "user", "request": { "contentType": "application/json", - "description": "Example", + "description": "User", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Check Commits", - "script": "scripts/commit_check.sh", - "enforcement": "disabled", - "allow_downstream_configuration": false, - "script_repository": { - "full_name": "DevIT/hooks" + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" }, - "environment": { - "id": 2 - } + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true + } + ], + "roles": [ + { + "value": "User", + "primary": false + } + ] + }, + "parameters": { + "scim_user_id": "SCIM_USER_ID" } }, "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", + "statusCode": "200", + "contentType": "application/scim+json", + "description": "User was updated
", "example": { - "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" + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "7fce0092-d52e-4f76-b727-3955bd72c939", + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" }, - "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 + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true } - }, - "allow_downstream_configuration": false + ], + "roles": [ + { + "value": "User", + "primary": false + } + ], + "meta": { + "resourceType": "User", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" + } }, "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "script": { - "type": "string" - }, - "script_repository": { + "allOf": [ + { "type": "object", + "required": [ + "schemas", + "active", + "emails" + ], "properties": { - "id": { - "type": "integer" + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] }, - "full_name": { - "type": "string" + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "E012345" + ] }, - "url": { - "type": "string" + "active": { + "type": "boolean", + "description": "Whether the user active in the IdP.", + "examples": [ + true + ] }, - "html_url": { - "type": "string" + "userName": { + "type": "string", + "description": "The username for the user.", + "examples": [ + "E012345" + ] + }, + "name": { + "type": "object", + "properties": { + "formatted": { + "type": "string", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "examples": [ + "Ms. Mona Lisa Octocat" + ] + }, + "familyName": { + "type": "string", + "description": "The family name of the user.", + "examples": [ + "Octocat" + ] + }, + "givenName": { + "type": "string", + "description": "The given name of the user.", + "examples": [ + "Mona" + ] + }, + "middleName": { + "type": "string", + "description": "The middle name(s) of the user.", + "examples": [ + "Lisa" + ] + } + } + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for the user.", + "examples": [ + "Mona Lisa" + ] + }, + "emails": { + "type": "array", + "description": "The emails for the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "The email address.", + "examples": [ + "mlisa@example.com" + ] + }, + "type": { + "type": "string", + "description": "The type of email address.", + "examples": [ + "work" + ] + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address.", + "examples": [ + true + ] + } + } + } + }, + "roles": { + "type": "array", + "description": "The roles assigned to the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "display": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "string", + "description": "The role value representing a user role in GitHub.", + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "examples": [ + "user" + ] + }, + "primary": { + "type": "boolean", + "description": "Is the role a primary role for the user.", + "examples": [ + false + ] + } + } + } } } }, - "environment": { + { "type": "object", + "required": [ + "id", + "meta" + ], "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" + "type": "string", + "description": "The internally generated id for the user object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] }, - "hooks_count": { - "type": "integer" + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "Provisioned SCIM groups that the user is a member of." }, - "download": { + "meta": { "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] }, - "downloaded_at": { - "type": [ - "string", - "null" + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" ] }, - "message": { - "type": [ - "string", - "null" + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" } } } } - }, - "allow_downstream_configuration": { - "type": "boolean" } - } + ] } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning: Setting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Created
" + "httpStatusCode": "200", + "description": "User was updated
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authorization failure
" + }, + { + "httpStatusCode": "403", + "description": "Permission denied
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "409", + "description": "Duplicate record detected
" + }, + { + "httpStatusCode": "429", + "description": "Too many requests
" + }, + { + "httpStatusCode": "500", + "description": "Internal server error
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Get a pre-receive hook", + "verb": "patch", + "requestPath": "/scim/v2/Users/{scim_user_id}", + "title": "Update an attribute for a SCIM enterprise user", "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", + "subcategory": "scim", "parameters": [ { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.
", + "name": "scim_user_id", + "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], - "bodyParameters": [], - "enabledForGitHubApps": false, + "bodyParameters": [ + { + "type": "array of objects", + "name": "Operations", + "in": "body", + "description": "patch operations list
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "op", + "description": "", + "isRequired": true, + "enum": [ + "add", + "replace", + "remove" + ] + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "string", + "name": "value", + "description": "Corresponding 'value' of that field specified by 'path'
" + } + ] + }, + { + "type": "array of strings", + "name": "schemas", + "in": "body", + "description": "", + "isRequired": true + } + ], + "enabledForGitHubApps": true, "codeExamples": [ { - "key": "default", + "key": "userMultiValuedProperties", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Multi Valued Property", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "replace", + "path": "emails[type eq 'work'].value", + "value": "updatedEmail@microsoft.com" + }, + { + "op": "replace", + "path": "name.familyName", + "value": "updatedFamilyName" + } + ] + }, + "parameters": { + "scim_user_id": "SCIM_USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/scim+json", + "description": "Success, user was updated
", + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "7fce0092-d52e-4f76-b727-3955bd72c939", + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" + }, + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true + } + ], + "roles": [ + { + "value": "User", + "primary": false + } + ], + "meta": { + "resourceType": "User", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" + } + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "schemas", + "active", + "emails" + ], + "properties": { + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "E012345" + ] + }, + "active": { + "type": "boolean", + "description": "Whether the user active in the IdP.", + "examples": [ + true + ] + }, + "userName": { + "type": "string", + "description": "The username for the user.", + "examples": [ + "E012345" + ] + }, + "name": { + "type": "object", + "properties": { + "formatted": { + "type": "string", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "examples": [ + "Ms. Mona Lisa Octocat" + ] + }, + "familyName": { + "type": "string", + "description": "The family name of the user.", + "examples": [ + "Octocat" + ] + }, + "givenName": { + "type": "string", + "description": "The given name of the user.", + "examples": [ + "Mona" + ] + }, + "middleName": { + "type": "string", + "description": "The middle name(s) of the user.", + "examples": [ + "Lisa" + ] + } + } + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for the user.", + "examples": [ + "Mona Lisa" + ] + }, + "emails": { + "type": "array", + "description": "The emails for the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "The email address.", + "examples": [ + "mlisa@example.com" + ] + }, + "type": { + "type": "string", + "description": "The type of email address.", + "examples": [ + "work" + ] + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address.", + "examples": [ + true + ] + } + } + } + }, + "roles": { + "type": "array", + "description": "The roles assigned to the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "display": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "string", + "description": "The role value representing a user role in GitHub.", + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "examples": [ + "user" + ] + }, + "primary": { + "type": "boolean", + "description": "Is the role a primary role for the user.", + "examples": [ + false + ] + } + } + } + } + } + }, + { + "type": "object", + "required": [ + "id", + "meta" + ], + "properties": { + "id": { + "type": "string", + "description": "The internally generated id for the user object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "Provisioned SCIM groups that the user is a member of." + }, + "meta": { + "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], + "properties": { + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] + }, + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" + ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" + } + } + } + } + } + ] + } + } + }, + { + "key": "userSingleValuedProperties", + "request": { + "contentType": "application/json", + "description": "Single Valued Property", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "replace", + "path": "userName", + "value": "5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com" + }, + { + "op": "replace", + "path": "displayName", + "value": "Monalisa Octocat" + } + ] + }, "parameters": { - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" + "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", - "contentType": "application/json", - "description": "Response
", + "contentType": "application/scim+json", + "description": "Success, user was updated
", "example": { - "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" + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "7fce0092-d52e-4f76-b727-3955bd72c939", + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" }, - "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 + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true } - }, - "allow_downstream_configuration": false + ], + "roles": [ + { + "value": "User", + "primary": false + } + ], + "meta": { + "resourceType": "User", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" + } }, "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "script": { - "type": "string" - }, - "script_repository": { + "allOf": [ + { "type": "object", + "required": [ + "schemas", + "active", + "emails" + ], "properties": { - "id": { - "type": "integer" + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] }, - "full_name": { - "type": "string" + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "E012345" + ] }, - "url": { - "type": "string" + "active": { + "type": "boolean", + "description": "Whether the user active in the IdP.", + "examples": [ + true + ] }, - "html_url": { - "type": "string" + "userName": { + "type": "string", + "description": "The username for the user.", + "examples": [ + "E012345" + ] + }, + "name": { + "type": "object", + "properties": { + "formatted": { + "type": "string", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "examples": [ + "Ms. Mona Lisa Octocat" + ] + }, + "familyName": { + "type": "string", + "description": "The family name of the user.", + "examples": [ + "Octocat" + ] + }, + "givenName": { + "type": "string", + "description": "The given name of the user.", + "examples": [ + "Mona" + ] + }, + "middleName": { + "type": "string", + "description": "The middle name(s) of the user.", + "examples": [ + "Lisa" + ] + } + } + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for the user.", + "examples": [ + "Mona Lisa" + ] + }, + "emails": { + "type": "array", + "description": "The emails for the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "The email address.", + "examples": [ + "mlisa@example.com" + ] + }, + "type": { + "type": "string", + "description": "The type of email address.", + "examples": [ + "work" + ] + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address.", + "examples": [ + true + ] + } + } + } + }, + "roles": { + "type": "array", + "description": "The roles assigned to the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "display": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "string", + "description": "The role value representing a user role in GitHub.", + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "examples": [ + "user" + ] + }, + "primary": { + "type": "boolean", + "description": "Is the role a primary role for the user.", + "examples": [ + false + ] + } + } + } } } }, - "environment": { + { "type": "object", + "required": [ + "id", + "meta" + ], "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" + "type": "string", + "description": "The internally generated id for the user object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] }, - "hooks_count": { - "type": "integer" + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "Provisioned SCIM groups that the user is a member of." }, - "download": { + "meta": { "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] }, - "downloaded_at": { - "type": [ - "string", - "null" + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" ] }, - "message": { - "type": [ - "string", - "null" + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" } } } } - }, - "allow_downstream_configuration": { - "type": "boolean" } - } + ] } } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Update a pre-receive hook", - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "The name of the hook.
" - }, - { - "type": "string", - "name": "script", - "in": "body", - "description": "The script that the hook runs.
" - }, - { - "type": "object", - "name": "script_repository", - "in": "body", - "description": "The GitHub repository where the script is kept.
" - }, - { - "type": "object", - "name": "environment", - "in": "body", - "description": "The pre-receive environment where the script is executed.
" - }, - { - "type": "string", - "name": "enforcement", - "in": "body", - "description": "The state of enforcement for this hook.
" }, { - "type": "boolean", - "name": "allow_downstream_configuration", - "in": "body", - "description": "Whether enforcement can be overridden at the org or repo level.
" - } - ], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "default", + "key": "disableUser", "request": { "contentType": "application/json", - "description": "Example", + "description": "Disable User", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Check Commits", - "environment": { - "id": 1 - }, - "allow_downstream_configuration": true + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "replace", + "path": "active", + "value": false + } + ] }, "parameters": { - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" + "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", - "contentType": "application/json", - "description": "Response
", + "contentType": "application/scim+json", + "description": "Success, user was updated
", "example": { - "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" + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "id": "7fce0092-d52e-4f76-b727-3955bd72c939", + "externalId": "E012345", + "active": true, + "userName": "E012345", + "name": { + "formatted": "Ms. Mona Lisa Octocat", + "familyName": "Octocat", + "givenName": "Mona", + "middleName": "Lisa" }, - "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 + "displayName": "Mona Lisa", + "emails": [ + { + "value": "mlisa@example.com", + "type": "work", + "primary": true } - }, - "allow_downstream_configuration": true + ], + "roles": [ + { + "value": "User", + "primary": false + } + ], + "meta": { + "resourceType": "User", + "created": "2012-03-27T19:59:26.000Z", + "lastModified": "2018-03-27T19:59:26.000Z", + "location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939" + } }, "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "script": { - "type": "string" - }, - "script_repository": { + "allOf": [ + { "type": "object", + "required": [ + "schemas", + "active", + "emails" + ], "properties": { - "id": { - "type": "integer" + "schemas": { + "type": "array", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "items": { + "type": "string", + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] + }, + "examples": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ] }, - "full_name": { - "type": "string" + "externalId": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the resource as defined by the provisioning client.", + "examples": [ + "E012345" + ] }, - "url": { - "type": "string" + "active": { + "type": "boolean", + "description": "Whether the user active in the IdP.", + "examples": [ + true + ] }, - "html_url": { - "type": "string" + "userName": { + "type": "string", + "description": "The username for the user.", + "examples": [ + "E012345" + ] + }, + "name": { + "type": "object", + "properties": { + "formatted": { + "type": "string", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "examples": [ + "Ms. Mona Lisa Octocat" + ] + }, + "familyName": { + "type": "string", + "description": "The family name of the user.", + "examples": [ + "Octocat" + ] + }, + "givenName": { + "type": "string", + "description": "The given name of the user.", + "examples": [ + "Mona" + ] + }, + "middleName": { + "type": "string", + "description": "The middle name(s) of the user.", + "examples": [ + "Lisa" + ] + } + } + }, + "displayName": { + "type": [ + "string", + "null" + ], + "description": "A human-readable name for the user.", + "examples": [ + "Mona Lisa" + ] + }, + "emails": { + "type": "array", + "description": "The emails for the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "The email address.", + "examples": [ + "mlisa@example.com" + ] + }, + "type": { + "type": "string", + "description": "The type of email address.", + "examples": [ + "work" + ] + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address.", + "examples": [ + true + ] + } + } + } + }, + "roles": { + "type": "array", + "description": "The roles assigned to the user.", + "items": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "display": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "string", + "description": "The role value representing a user role in GitHub.", + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "examples": [ + "user" + ] + }, + "primary": { + "type": "boolean", + "description": "Is the role a primary role for the user.", + "examples": [ + false + ] + } + } + } } } }, - "environment": { + { "type": "object", + "required": [ + "id", + "meta" + ], "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" + "type": "string", + "description": "The internally generated id for the user object.", + "examples": [ + "7fce0092-d52e-4f76-b727-3955bd72c939" + ] }, - "hooks_count": { - "type": "integer" + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + }, + "description": "Provisioned SCIM groups that the user is a member of." }, - "download": { + "meta": { "type": "object", + "description": "The metadata associated with the creation/updates to the user.", + "required": [ + "resourceType" + ], "properties": { - "url": { - "type": "string" - }, - "state": { - "type": "string" + "resourceType": { + "type": "string", + "description": "A type of a resource", + "enum": [ + "User", + "Group" + ], + "examples": [ + "User" + ] }, - "downloaded_at": { - "type": [ - "string", - "null" + "created": { + "type": "string", + "description": "A date and time when the user was created.", + "examples": [ + "2022-03-27T19:59:26.000Z" ] }, - "message": { - "type": [ - "string", - "null" + "lastModified": { + "type": "string", + "description": "A data and time when the user was last modified.", + "examples": [ + "2022-03-27T19:59:26.000Z" ] + }, + "location": { + "type": "string", + "description": "A URL location of an object" } } } } - }, - "allow_downstream_configuration": { - "type": "boolean" } - } + ] } } } ], - "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Delete a pre-receive hook", - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks", - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ] - } - ], - "repo-pre-receive-hooks": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "title": "List pre-receive hooks for a repository", - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks", - "parameters": [ + "description": "Success, user was updated
" + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "400", + "description": "Bad request
" }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "401", + "description": "Authorization failure
" }, { - "name": "per_page", - "description": "The number of results per page (max 100).
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } + "httpStatusCode": "403", + "description": "Permission denied
" }, { - "name": "page", - "description": "Page number of the results to fetch.
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } + "httpStatusCode": "404", + "description": "Resource not found
" }, { - "name": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } + "httpStatusCode": "409", + "description": "Duplicate record detected
" }, { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "name" - ], - "default": "created" - }, - "description": "" - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ + "httpStatusCode": "429", + "description": "Too many requests
" + }, { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - } - } - } - } - } + "httpStatusCode": "500", + "description": "Internal server error
" } ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ] + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning: Setting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nThe account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", + "name": "scim_user_id", + "description": "The unique identifier of the SCIM user.
", "in": "path", "required": true, "schema": { "type": "string" } - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "bodyParameters": [], @@ -172228,241 +220650,45 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" + "scim_user_id": "SCIM_USER_ID" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - } - } - } + "statusCode": "204", + "description": "User was deleted, no content
" } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Update pre-receive hook enforcement for a repository", - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "204", + "description": "User was deleted, no content
" }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "400", + "description": "Bad request
" }, { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "enforcement", - "in": "body", - "description": "The state of enforcement for the hook on this repository.
", - "enum": [ - "enabled", - "disabled", - "testing" - ] - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "enforcement": "enabled" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "enabled", - "configuration_url": "https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42" - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "title": "Remove pre-receive hook enforcement for a repository", - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "401", + "description": "Authorization failure
" }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "httpStatusCode": "403", + "description": "Permission denied
" }, { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ + "httpStatusCode": "404", + "description": "Resource not found
" + }, { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Responds with effective values inherited from owner and/or global level.
", - "example": { - "id": 42, - "name": "Check Commits", - "enforcement": "disabled", - "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42" - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "enforcement": { - "type": "string" - }, - "configuration_url": { - "type": "string" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", - "statusCodes": [ + "httpStatusCode": "429", + "description": "Too many requests
" + }, { - "httpStatusCode": "200", - "description": "Responds with effective values inherited from owner and/or global level.
" + "httpStatusCode": "500", + "description": "Internal server error
" } ] } @@ -172610,6 +220836,19 @@ "created_at": { "type": "string", "format": "date-time" + }, + "added_by": { + "type": [ + "string", + "null" + ] + }, + "last_used": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ @@ -173113,6 +221352,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -173201,6 +221448,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -173264,14 +221519,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -173595,7 +221842,7 @@ "type": "string", "name": "email", "in": "body", - "description": "Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"
" + "description": "Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"
" } ], "enabledForGitHubApps": false, @@ -173800,7 +222047,7 @@ } ], "previews": [], - "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.
If the login name or email address is already associated with an account, the server will return a 422 response.
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.
If the login name or email address is already associated with an account, the server will return a 422 response.
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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -173949,7 +222196,7 @@ "type": "array of strings", "name": "scopes", "in": "body", - "description": "A list of scopes.
", + "description": "A list of scopes.
", "isRequired": true } ], @@ -174349,6 +222596,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -174437,6 +222692,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -174500,14 +222763,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -175149,6 +223404,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -175237,6 +223500,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -175300,14 +223571,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -175651,7 +223914,7 @@ } ], "previews": [], - "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
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.
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.
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.
You 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.\"
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.
You 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.\"
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.
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.
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.
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.
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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -186416,7 +234679,7 @@ } ], "previews": [], - "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
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.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request 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.
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.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request 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.
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.
Note: 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\".
", + "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.
Note: 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\".
", "statusCodes": [ { "httpStatusCode": "200", @@ -191656,7 +239919,7 @@ } ], "previews": [], - "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.
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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
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.
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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
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.\"
\nReturns an error if you try to delete a file that does not exist.
", + "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.\"
\nReturns an error if you try to delete a file that does not exist.
", "statusCodes": [ { "httpStatusCode": "201", @@ -192537,7 +240800,7 @@ } ], "previews": [], - "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", + "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "statusCodes": [ { "httpStatusCode": "200", @@ -192614,7 +240877,7 @@ } ], "previews": [], - "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", + "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "statusCodes": [ { "httpStatusCode": "200", @@ -195104,6 +243367,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -195475,6 +243746,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -195521,6 +243829,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -195533,6 +243881,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -196064,7 +244417,7 @@ } ], "previews": [], - "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.
Note: GitHub's REST API 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.
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.
Note: GitHub's REST API 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.
List issues in an organization assigned to the authenticated user.
\nNote: GitHub's REST API 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.
List issues in an organization assigned to the authenticated user.
\nNote: GitHub's REST API 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.
List issues in a repository. Only open issues will be listed.
\nNote: GitHub's REST API 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.
List issues in a repository. Only open issues will be listed.
\nNote: GitHub's REST API 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.
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.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "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.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -208419,6 +257042,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -208790,6 +257421,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -208836,6 +257504,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -208848,6 +257556,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -209378,7 +258091,7 @@ } ], "previews": [], - "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.
Note: GitHub's REST API 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.
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.
Note: GitHub's REST API 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.
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.\"
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.\"
List issues across owned and member repositories assigned to the authenticated user.
\nNote: GitHub's REST API 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.
List issues across owned and member repositories assigned to the authenticated user.
\nNote: GitHub's REST API 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.
Lists the available assignees for issues in a repository.
", + "descriptionHTML": "Lists the available assignees for issues in a repository.
", "statusCodes": [ { "httpStatusCode": "200", @@ -218930,6 +267823,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -219301,6 +268202,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -219347,6 +268285,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -219359,6 +268337,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -222176,6 +271159,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -222547,6 +271538,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -222593,6 +271621,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -222605,6 +271673,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -227087,7 +276160,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -229627,6 +278700,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -229998,6 +279079,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -230044,6 +279162,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -230056,6 +279214,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -234499,6 +283662,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -234870,6 +284041,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -234916,6 +284124,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -234928,6 +284176,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -247183,7 +296436,7 @@ "type": "array of strings", "name": "labels", "in": "body", - "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. 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. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"
The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. 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. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"
The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. 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. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"
The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. 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. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "title": "Delete a milestone", + "category": "issues", + "subcategory": "milestones", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "milestone_number", + "description": "The number that identifies the milestone.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "milestone_number": "MILESTONE_NUMBER" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], + "timeline": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", + "title": "List timeline events for an issue", + "category": "issues", + "subcategory": "timeline", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "issue_number": "ISSUE_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 6430295168, + "node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA", + "url": "https://api.github.com/repos/github/roadmap/issues/events/6430295168", + "actor": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/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/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "event": "locked", + "commit_id": null, + "commit_url": null, + "created_at": "2022-04-13T20:49:13Z", + "lock_reason": null, + "performed_via_github_app": null + }, + { + "id": 6430296748, + "node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs", + "url": "https://api.github.com/repos/github/roadmap/issues/events/6430296748", + "actor": { + "login": "github-product-roadmap", + "id": 67656570, + "node_id": "MDQ6VXNlcjY3NjU2NTcw", + "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github-product-roadmap", + "html_url": "https://github.com/github-product-roadmap", + "followers_url": "https://api.github.com/users/github-product-roadmap/followers", + "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", + "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", + "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", + "repos_url": "https://api.github.com/users/github-product-roadmap/repos", + "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", + "type": "User", + "site_admin": false + }, + "event": "labeled", + "commit_id": null, + "commit_url": null, + "created_at": "2022-04-13T20:49:34Z", + "label": { + "name": "beta", + "color": "99dd88" + }, + "performed_via_github_app": null + }, + { + "id": 6635165802, + "node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq", + "url": "https://api.github.com/repos/github/roadmap/issues/events/6635165802", + "actor": { + "login": "github-product-roadmap", + "id": 67656570, + "node_id": "MDQ6VXNlcjY3NjU2NTcw", + "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github-product-roadmap", + "html_url": "https://github.com/github-product-roadmap", + "followers_url": "https://api.github.com/users/github-product-roadmap/followers", + "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", + "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", + "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", + "repos_url": "https://api.github.com/users/github-product-roadmap/repos", + "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", + "type": "User", + "site_admin": false + }, + "event": "renamed", + "commit_id": null, + "commit_url": null, + "created_at": "2022-05-18T19:29:01Z", + "rename": { + "from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)", + "to": "Secret scanning: dry-runs for enterprise-level custom patterns" + }, + "performed_via_github_app": null + }, + { + "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857", + "html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857", + "issue_url": "https://api.github.com/repos/github/roadmap/issues/493", + "id": 1130876857, + "node_id": "IC_kwDODwFebM5DZ8-5", + "user": { + "login": "octocat", + "id": 94867353, + "node_id": "U_kgDOBaePmQ", + "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_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 + }, + "created_at": "2022-05-19T00:52:15Z", + "updated_at": "2022-05-19T00:52:15Z", + "author_association": "COLLABORATOR", + "body": "🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/", + "reactions": { + "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "performed_via_github_app": null, + "event": "commented", + "actor": { + "login": "octocat", + "id": 94867353, + "node_id": "U_kgDOBaePmQ", + "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_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 + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Timeline Event", + "description": "Timeline Event", + "type": "object", + "anyOf": [ + { + "title": "Labeled Issue Event", + "description": "Labeled Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "label": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "color": { + "type": "string" + } }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "required": [ + "name", + "color" + ] + } + }, + "required": [ + "label", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + { + "title": "Unlabeled Issue Event", + "description": "Unlabeled Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "label": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "color": { + "type": "string" + } }, - "site_admin": { - "type": "boolean" + "required": [ + "name", + "color" + ] + } + }, + "required": [ + "label", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + { + "title": "Milestoned Issue Event", + "description": "Milestoned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "title": "Delete a milestone", - "category": "issues", - "subcategory": "milestones", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "milestone_number": "MILESTONE_NUMBER" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - } - ], - "timeline": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "title": "List timeline events for an issue", - "category": "issues", - "subcategory": "timeline", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "per_page", - "description": "The number of 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 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "issue_number": "ISSUE_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "id": 6430295168, - "node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA", - "url": "https://api.github.com/repos/github/roadmap/issues/events/6430295168", - "actor": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/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/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "event": "locked", - "commit_id": null, - "commit_url": null, - "created_at": "2022-04-13T20:49:13Z", - "lock_reason": null, - "performed_via_github_app": null - }, - { - "id": 6430296748, - "node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs", - "url": "https://api.github.com/repos/github/roadmap/issues/events/6430296748", - "actor": { - "login": "github-product-roadmap", - "id": 67656570, - "node_id": "MDQ6VXNlcjY3NjU2NTcw", - "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github-product-roadmap", - "html_url": "https://github.com/github-product-roadmap", - "followers_url": "https://api.github.com/users/github-product-roadmap/followers", - "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", - "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", - "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", - "repos_url": "https://api.github.com/users/github-product-roadmap/repos", - "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", - "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", - "type": "User", - "site_admin": false - }, - "event": "labeled", - "commit_id": null, - "commit_url": null, - "created_at": "2022-04-13T20:49:34Z", - "label": { - "name": "beta", - "color": "99dd88" - }, - "performed_via_github_app": null - }, - { - "id": 6635165802, - "node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq", - "url": "https://api.github.com/repos/github/roadmap/issues/events/6635165802", - "actor": { - "login": "github-product-roadmap", - "id": 67656570, - "node_id": "MDQ6VXNlcjY3NjU2NTcw", - "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github-product-roadmap", - "html_url": "https://github.com/github-product-roadmap", - "followers_url": "https://api.github.com/users/github-product-roadmap/followers", - "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", - "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", - "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", - "repos_url": "https://api.github.com/users/github-product-roadmap/repos", - "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", - "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", - "type": "User", - "site_admin": false - }, - "event": "renamed", - "commit_id": null, - "commit_url": null, - "created_at": "2022-05-18T19:29:01Z", - "rename": { - "from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)", - "to": "Secret scanning: dry-runs for enterprise-level custom patterns" - }, - "performed_via_github_app": null - }, - { - "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857", - "html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857", - "issue_url": "https://api.github.com/repos/github/roadmap/issues/493", - "id": 1130876857, - "node_id": "IC_kwDODwFebM5DZ8-5", - "user": { - "login": "octocat", - "id": 94867353, - "node_id": "U_kgDOBaePmQ", - "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_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 - }, - "created_at": "2022-05-19T00:52:15Z", - "updated_at": "2022-05-19T00:52:15Z", - "author_association": "COLLABORATOR", - "body": "🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/", - "reactions": { - "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions", - "total_count": 0, - "+1": 0, - "-1": 0, - "laugh": 0, - "hooray": 0, - "confused": 0, - "heart": 0, - "rocket": 0, - "eyes": 0 - }, - "performed_via_github_app": null, - "event": "commented", - "actor": { - "login": "octocat", - "id": 94867353, - "node_id": "U_kgDOBaePmQ", - "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_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 - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Timeline Event", - "description": "Timeline Event", - "type": "object", - "anyOf": [ + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "milestone": { + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + } + }, + "required": [ + "milestone", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, { - "title": "Labeled Issue Event", - "description": "Labeled Issue Event", + "title": "Demilestoned Issue Event", + "description": "Demilestoned Issue Event", "type": "object", "properties": { "id": { @@ -251258,24 +302169,20 @@ } ] }, - "label": { + "milestone": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "color": { + "title": { "type": "string" } }, "required": [ - "name", - "color" + "title" ] } }, "required": [ - "label", + "milestone", "id", "node_id", "url", @@ -251288,8 +302195,8 @@ ] }, { - "title": "Unlabeled Issue Event", - "description": "Unlabeled Issue Event", + "title": "Renamed Issue Event", + "description": "Renamed Issue Event", "type": "object", "properties": { "id": { @@ -251812,24 +302719,24 @@ } ] }, - "label": { + "rename": { "type": "object", "properties": { - "name": { + "from": { "type": "string" }, - "color": { + "to": { "type": "string" } }, "required": [ - "name", - "color" + "from", + "to" ] } }, "required": [ - "label", + "rename", "id", "node_id", "url", @@ -251842,8 +302749,8 @@ ] }, { - "title": "Milestoned Issue Event", - "description": "Milestoned Issue Event", + "title": "Review Requested Issue Event", + "description": "Review Requested Issue Event", "type": "object", "properties": { "id": { @@ -252366,20 +303273,531 @@ } ] }, - "milestone": { + "review_requester": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "title": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "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", + "null" + ] + }, + "privacy": { "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] } }, "required": [ - "title" + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "requested_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "milestone", + "review_requester", "id", "node_id", "url", @@ -252392,8 +303810,8 @@ ] }, { - "title": "Demilestoned Issue Event", - "description": "Demilestoned Issue Event", + "title": "Review Request Removed Issue Event", + "description": "Review Request Removed Issue Event", "type": "object", "properties": { "id": { @@ -252913,23 +304331,534 @@ "permissions", "events" ] - } - ] - }, - "milestone": { - "type": "object", - "properties": { - "title": { - "type": "string" + } + ] + }, + "review_requester": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "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", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "requested_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } }, "required": [ - "title" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "milestone", + "review_requester", "id", "node_id", "url", @@ -252942,8 +304871,8 @@ ] }, { - "title": "Renamed Issue Event", - "description": "Renamed Issue Event", + "title": "Review Dismissed Issue Event", + "description": "Review Dismissed Issue Event", "type": "object", "properties": { "id": { @@ -253466,24 +305395,34 @@ } ] }, - "rename": { + "dismissed_review": { "type": "object", "properties": { - "from": { + "state": { "type": "string" }, - "to": { + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": [ + "string", + "null" + ] + }, + "dismissal_commit_id": { "type": "string" } }, "required": [ - "from", - "to" + "state", + "review_id", + "dismissal_message" ] } }, "required": [ - "rename", + "dismissed_review", "id", "node_id", "url", @@ -253496,8 +305435,8 @@ ] }, { - "title": "Review Requested Issue Event", - "description": "Review Requested Issue Event", + "title": "Locked Issue Event", + "description": "Locked Issue Event", "type": "object", "properties": { "id": { @@ -254020,531 +305959,18 @@ } ] }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - "requested_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "lock_reason": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"off-topic\"" ] } }, "required": [ - "review_requester", + "lock_reason", "id", "node_id", "url", @@ -254557,8 +305983,8 @@ ] }, { - "title": "Review Request Removed Issue Event", - "description": "Review Request Removed Issue Event", + "title": "Added to Project Issue Event", + "description": "Added to Project Issue Event", "type": "object", "properties": { "id": { @@ -255065,547 +306491,56 @@ ] } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" ] }, - "requested_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", + "project_card": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "type": "integer" }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "project_id": { + "type": "integer" }, - "type": { + "project_url": { "type": "string", - "examples": [ - "User" - ] + "format": "uri" }, - "site_admin": { - "type": "boolean" + "column_name": { + "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "previous_column_name": { + "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" + "url", + "project_id", + "project_url", + "column_name" ] } }, "required": [ - "review_requester", "id", "node_id", "url", @@ -255618,8 +306553,8 @@ ] }, { - "title": "Review Dismissed Issue Event", - "description": "Review Dismissed Issue Event", + "title": "Moved Column in Project Issue Event", + "description": "Moved Column in Project Issue Event", "type": "object", "properties": { "id": { @@ -256142,34 +307077,40 @@ } ] }, - "dismissed_review": { + "project_card": { "type": "object", "properties": { - "state": { - "type": "string" + "id": { + "type": "integer" }, - "review_id": { + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { "type": "integer" }, - "dismissal_message": { - "type": [ - "string", - "null" - ] + "project_url": { + "type": "string", + "format": "uri" }, - "dismissal_commit_id": { + "column_name": { + "type": "string" + }, + "previous_column_name": { "type": "string" } }, "required": [ - "state", - "review_id", - "dismissal_message" + "id", + "url", + "project_id", + "project_url", + "column_name" ] } }, "required": [ - "dismissed_review", "id", "node_id", "url", @@ -256182,8 +307123,8 @@ ] }, { - "title": "Locked Issue Event", - "description": "Locked Issue Event", + "title": "Removed from Project Issue Event", + "description": "Removed from Project Issue Event", "type": "object", "properties": { "id": { @@ -256706,18 +307647,40 @@ } ] }, - "lock_reason": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"off-topic\"" + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" ] } }, "required": [ - "lock_reason", "id", "node_id", "url", @@ -256730,8 +307693,8 @@ ] }, { - "title": "Added to Project Issue Event", - "description": "Added to Project Issue Event", + "title": "Converted Note to Issue Issue Event", + "description": "Converted Note to Issue Issue Event", "type": "object", "properties": { "id": { @@ -256913,14 +307876,785 @@ "null" ] }, - "commit_url": { - "type": [ - "string", - "null" - ] + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + { + "title": "Timeline Comment Event", + "description": "Timeline Comment Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" }, - "created_at": { - "type": "string" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] }, "performed_via_github_app": { "anyOf": [ @@ -257254,63 +308988,76 @@ } ] }, - "project_card": { + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "id": { - "type": "integer" - }, "url": { "type": "string", "format": "uri" }, - "project_id": { + "total_count": { "type": "integer" }, - "project_url": { - "type": "string", - "format": "uri" + "+1": { + "type": "integer" }, - "column_name": { - "type": "string" + "-1": { + "type": "integer" }, - "previous_column_name": { - "type": "string" + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, "required": [ - "id", "url", - "project_id", - "project_url", - "column_name" + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ + "event", + "actor", "id", "node_id", + "html_url", + "issue_url", + "author_association", + "user", "url", - "actor", - "event", - "commit_id", - "commit_url", "created_at", - "performed_via_github_app" + "updated_at" ] }, { - "title": "Moved Column in Project Issue Event", - "description": "Moved Column in Project Issue Event", + "title": "Timeline Cross Referenced Event", + "description": "Timeline Cross Referenced Event", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { + "event": { "type": "string" }, "actor": { @@ -257474,55 +309221,1048 @@ "url" ] }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" + "updated_at": { + "type": "string", + "format": "date-time" + }, + "source": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - { - "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.", + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the GitHub app", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", "type": "integer", "examples": [ - 37 + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } ] }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "owner": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "anyOf": [ { "type": "null" @@ -257690,414 +310430,306 @@ } ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] + "body_html": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] + "body_text": { + "type": "string" }, - "updated_at": { + "timeline_url": { "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] + "format": "uri" }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "issues": { - "type": "string" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] }, - "checks": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "metadata": { - "type": "string" + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] }, - "contents": { - "type": "string" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Removed from Project Issue Event", - "description": "Removed from Project Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] }, - { + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -258257,1557 +310889,1672 @@ "type", "url" ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] }, - "metadata": { - "type": "string" + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] }, - "contents": { - "type": "string" + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Converted Note to Issue Issue Event", - "description": "Converted Note to Issue Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "event": { - "type": "string" - }, - "commit_id": { - "type": [ - "string", - "null" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ] - }, - "created_at": { - "type": "string" - }, - "performed_via_github_app": { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "email": { - "type": [ - "string", - "null" + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "login": { + "languages_url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "id": { - "type": "integer", + "merges_url": { + "type": "string", + "format": "uri", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "node_id": { + "milestones_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "avatar_url": { + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "statuses_url": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "html_url": { + "subscription_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "followers_url": { + "tags_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "following_url": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "gists_url": { + "trees_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "starred_url": { + "clone_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "https://github.com/octocat/Hello-World.git" ] }, - "subscriptions_url": { + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "organizations_url": { + "svn_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false ] }, - "repos_url": { + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, - "events_url": { + "squash_merge_commit_message": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, - "received_events_url": { + "merge_commit_title": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, - "type": { + "merge_commit_message": { "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "User" + true ] }, - "site_admin": { + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, "type": "boolean" }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - }, - "project_card": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "column_name": { - "type": "string" - }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "project_id", - "project_url", - "column_name" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at", - "performed_via_github_app" - ] - }, - { - "title": "Timeline Comment Event", - "description": "Timeline Comment Event", - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "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" ] }, - "owner": { + "performed_via_github_app": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "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": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", "examples": [ - "octocat" + 37 ] }, - "id": { - "type": "integer", + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", "examples": [ - 1 + "probot-owners" ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "avatar_url": { + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "Probot Owners" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "The description of the app." ] }, - "url": { + "external_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "https://github.com/apps/super-ci" ] }, - "gists_url": { + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "2017-07-08T16:18:44-04:00" ] }, - "starred_url": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "2017-07-08T16:18:44-04:00" ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "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" + } }, - "organizations_url": { - "type": "string", - "format": "uri", + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "https://api.github.com/users/octocat/orgs" + "label", + "deployment" ] }, - "repos_url": { - "type": "string", - "format": "uri", + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/repos" + 5 ] }, - "events_url": { + "client_id": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "received_events_url": { + "client_secret": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" ] }, - "type": { - "type": "string", + "webhook_secret": { + "type": [ + "string", + "null" + ], "examples": [ - "User" + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "pem": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"-----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": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] } ] }, - "name": { - "description": "The name of the GitHub app", + "author_association": { + "title": "author_association", "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" + "OWNER" ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "issues": { - "type": "string" + "url": { + "type": "string", + "format": "uri" }, - "checks": { - "type": "string" + "total_count": { + "type": "integer" }, - "metadata": { - "type": "string" + "+1": { + "type": "integer" }, - "contents": { - "type": "string" + "-1": { + "type": "integer" }, - "deployments": { - "type": "string" + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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": [ + "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", - "owner", - "name", - "description", - "external_url", - "html_url", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", "created_at", - "updated_at", - "permissions", - "events" + "updated_at" ] } + } + } + }, + "required": [ + "event", + "created_at", + "updated_at", + "source" + ] + }, + { + "title": "Timeline Committed Event", + "description": "Timeline Committed Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "reactions": { - "title": "Reaction Rollup", + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "author": { + "description": "Identifying information for the git-user", "type": "object", "properties": { - "url": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", - "format": "uri" + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, - "total_count": { - "type": "integer" + "email": { + "type": "string", + "description": "Git email address of the user", + "examples": [ + "monalisa.octocat@example.com" + ] }, - "+1": { - "type": "integer" + "name": { + "description": "Name of the git user", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "committer": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", + "type": "string", + "examples": [ + "2014-08-09T08:02:04+12:00" + ] }, - "-1": { - "type": "integer" + "email": { + "type": "string", + "description": "Git email address of the user", + "examples": [ + "monalisa.octocat@example.com" + ] }, - "laugh": { - "type": "integer" + "name": { + "description": "Name of the git user", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "message": { + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] }, - "confused": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "heart": { - "type": "integer" + "required": [ + "sha", + "url", + "html_url" + ] + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" }, - "hooray": { - "type": "integer" + "reason": { + "type": "string" }, - "eyes": { - "type": "integer" + "signature": { + "type": [ + "string", + "null" + ] }, - "rocket": { - "type": "integer" + "payload": { + "type": [ + "string", + "null" + ] } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "verified", + "reason", + "signature", + "payload" ] + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "event", - "actor", - "id", + "sha", "node_id", - "html_url", - "issue_url", - "author_association", - "user", "url", - "created_at", - "updated_at" + "html_url", + "author", + "committer", + "tree", + "message", + "parents", + "verification" ] }, { - "title": "Timeline Cross Referenced Event", - "description": "Timeline Cross Referenced Event", + "title": "Timeline Reviewed Event", + "description": "Timeline Reviewed Event", "type": "object", "properties": { "event": { "type": "string" }, - "actor": { + "id": { + "description": "Unique identifier of the review", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" + ] + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -259968,496 +312715,693 @@ "url" ] }, - "created_at": { + "body": { + "description": "The text of the review.", + "type": [ + "string", + "null" + ], + "examples": [ + "This looks great." + ] + }, + "state": { "type": "string", - "format": "date-time" + "examples": [ + "CHANGES_REQUESTED" + ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + ] }, - "source": { + "pull_request_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/12" + ] + }, + "_links": { "type": "object", "properties": { - "type": { - "type": "string" - }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "html": { "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { + "href": { "type": "string" - }, - "url": { - "description": "URL for the issue", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { + } + }, + "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.", + "type": "string", + "examples": [ + "54bb654c9e6025347f57900a4a5c2313a96b8035" + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + } + }, + "required": [ + "event", + "id", + "node_id", + "user", + "body", + "state", + "commit_id", + "html_url", + "pull_request_url", + "_links", + "author_association" + ] + }, + { + "title": "Timeline Line Commented Event", + "description": "Timeline Line Commented Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "comments": { + "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", + "type": "string", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + ] + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": [ + "integer", + "null" + ], + "examples": [ + 42 + ] + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string", + "examples": [ + "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" + ] + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string", + "examples": [ + "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + ] + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string", + "examples": [ + "config/database.yaml" + ] + }, + "position": { + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", + "type": "integer", + "examples": [ + 1 + ] + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", + "type": "integer", + "examples": [ + 4 + ] + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string", + "examples": [ + "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" + ] + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer", + "examples": [ + 8 + ] + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "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", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string", + "examples": [ + "We should probably include a check for null values here." + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri", + "examples": [ + "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", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + ] } + }, + "required": [ + "href" ] }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" + "html": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + ] + } }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": [ + "href" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/1" + ] + } + }, + "required": [ + "href" + ] + } }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { + "required": [ + "self", + "html", + "pull_request" + ] + }, + "start_line": { + "type": [ + "integer", + "null" + ], + "description": "The first line of the range for a multi-line comment.", + "examples": [ + 2 + ] + }, + "original_start_line": { + "type": [ + "integer", + "null" + ], + "description": "The first line of the range for a multi-line comment.", + "examples": [ + 2 + ] + }, + "start_side": { + "type": [ + "string", + "null" + ], + "description": "The side of the first line of the range for a multi-line comment.", + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "examples": [ + 2 + ] + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "examples": [ + 2 + ] + }, + "side": { + "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", + "enum": [ + "LEFT", + "RIGHT" + ], + "default": "RIGHT", + "type": "string" + }, + "reactions": { + "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", + "examples": [ + "\"comment body
\"" + ] + }, + "body_text": { + "type": "string", + "examples": [ + "\"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" + ] + } + } + } + }, + { + "title": "Timeline Commit Commented Event", + "description": "Timeline Commit Commented Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "comments": { + "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", + "null" + ] + }, + "position": { + "type": [ + "integer", + "null" + ] + }, + "line": { + "type": [ + "integer", + "null" + ] + }, + "commit_id": { + "type": "string" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -260497,519 +313441,448 @@ "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } + ] }, - "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", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } }, - "url": { - "type": [ - "string", - "null" - ], - "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" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "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" + } }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "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" + ] + } + } + } + }, + { + "title": "Timeline Assigned Issue Event", + "description": "Timeline Assigned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] }, - "created_at": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "format": "date-time" + "examples": [ + "probot-owners" + ] }, - "updated_at": { + "node_id": { "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] }, - "closed_by": { + "owner": { "anyOf": [ { "type": "null" @@ -261177,306 +314050,544 @@ } ] }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app", + "assignee" + ] + }, + { + "title": "Timeline Unassigned Issue Event", + "description": "Timeline Unassigned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] }, - "timeline_url": { + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -261636,1582 +314747,5627 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { "type": "string" }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "checks": { + "type": "string" }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "metadata": { + "type": "string" }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] + "contents": { + "type": "string" }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app", + "assignee" + ] + }, + { + "title": "State Change Issue Event", + "description": "State Change Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": [ + "string", + "null" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" }, - "template_repository": { - "type": [ - "object", - "null" - ], + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, "name": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "full_name": { - "type": "string" + "email": { + "type": [ + "string", + "null" + ] }, - "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" - } - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "private": { - "type": "boolean" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "html_url": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "description": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "fork": { - "type": "boolean" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "collaborators_url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "comments_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "commits_url": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "compare_url": { - "type": "string" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "contents_url": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "contributors_url": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "deployments_url": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "downloads_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "delete_branch_on_merge": { - "type": "boolean" + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "allow_update_branch": { - "type": "boolean" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "allow_merge_commit": { + "site_admin": { "type": "boolean" }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - 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" ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" + "checks": { + "type": "string" }, - "master_branch": { + "metadata": { "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] + "contents": { + "type": "string" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "deployments": { + "type": "string" } }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "type": "integer", - "examples": [ - 5 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "client_secret": { - "type": "string", - "examples": [ - "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - ] - }, - "webhook_secret": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - ] - }, - "pem": { - "type": "string", - "examples": [ - "\"-----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" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "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" - } + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----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" + ] + } + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + } + ] + } + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "410", + "description": "Gone
" + } + ] + } + ] + }, + "licenses": { + "licenses": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/licenses", + "title": "Get all commonly used licenses", + "category": "licenses", + "parameters": [ + { + "name": "featured", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "description": "" + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "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==" + } + ], + "schema": { + "type": "array", + "items": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + } + ], + "subcategory": "licenses" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/licenses/{license}", + "title": "Get a license", + "category": "licenses", + "parameters": [ + { + "name": "license", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "" + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "license": "LICENSE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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 + }, + "schema": { + "title": "License", + "description": "License", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://choosealicense.com/licenses/mit/" + ] + }, + "description": { + "type": "string", + "examples": [ + "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", + "examples": [ + "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", + "items": { + "type": "string" + }, + "examples": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ] + }, + "conditions": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "include-copyright" + ] + }, + "limitations": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "no-liability" + ] + }, + "body": { + "type": "string", + "examples": [ + "\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", + "examples": [ + true + ] + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id", + "html_url", + "description", + "implementation", + "permissions", + "conditions", + "limitations", + "body", + "featured" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "subcategory": "licenses" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/license", + "title": "Get the license for a repository", + "category": "licenses", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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==" + } + }, + "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", + "null" + ], + "format": "uri" + }, + "git_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "download_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "type": { + "type": "string" + }, + "content": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "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" + ] + } + } + } + ], + "previews": [], + "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.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ], + "subcategory": "licenses" + } + ] + }, + "markdown": { + "markdown": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/markdown", + "title": "Render a Markdown document", + "category": "markdown", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "text", + "in": "body", + "description": "The Markdown text to render in HTML.
", + "isRequired": true + }, + { + "type": "string", + "name": "mode", + "in": "body", + "description": "The rendering mode.
", + "enum": [ + "markdown", + "gfm" + ], + "default": "markdown" + }, + { + "type": "string", + "name": "context", + "in": "body", + "description": "The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.
Example response
", + "example": "Hello world
", + "schema": { + "type": "string" + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + } + ], + "subcategory": "markdown" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/markdown/raw", + "title": "Render a Markdown document in raw mode", + "category": "markdown", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "text/plain", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "text": "Hello **world**" + } + }, + "response": { + "statusCode": "200", + "contentType": "text/html", + "description": "Example response
", + "example": "Hello world
", + "schema": { + "type": "string" + } + } + }, + { + "key": "default", + "request": { + "contentType": "text/x-markdown", + "description": "Rendering markdown", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "text": "Hello **world**" + } + }, + "response": { + "statusCode": "200", + "contentType": "text/html", + "description": "Example response
", + "example": "Hello world
", + "schema": { + "type": "string" + } + } + } + ], + "previews": [], + "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.
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + } + ], + "subcategory": "markdown" + } + ] + }, + "meta": { + "meta": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/", + "title": "GitHub API Root", + "category": "meta", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "current_user_url": "https://api.github.com/user", + "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}", + "authorizations_url": "https://api.github.com/authorizations", + "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}", + "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}", + "emails_url": "https://api.github.com/user/emails", + "emojis_url": "https://api.github.com/emojis", + "events_url": "https://api.github.com/events", + "feeds_url": "https://api.github.com/feeds", + "followers_url": "https://api.github.com/user/followers", + "following_url": "https://api.github.com/user/following{/target}", + "gists_url": "https://api.github.com/gists{/gist_id}", + "hub_url": "https://api.github.com/hub", + "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}", + "issues_url": "https://api.github.com/issues", + "keys_url": "https://api.github.com/user/keys", + "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}", + "notifications_url": "https://api.github.com/notifications", + "organization_url": "https://api.github.com/orgs/{org}", + "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}", + "organization_teams_url": "https://api.github.com/orgs/{org}/teams", + "public_gists_url": "https://api.github.com/gists/public", + "rate_limit_url": "https://api.github.com/rate_limit", + "repository_url": "https://api.github.com/repos/{owner}/{repo}", + "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}", + "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}", + "starred_url": "https://api.github.com/user/starred{/owner}{/repo}", + "starred_gists_url": "https://api.github.com/gists/starred", + "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}", + "user_url": "https://api.github.com/users/{user}", + "user_organizations_url": "https://api.github.com/user/orgs", + "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}", + "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}" + }, + "schema": { + "type": "object", + "properties": { + "current_user_url": { + "type": "string", + "format": "uri-template" + }, + "current_user_authorizations_html_url": { + "type": "string", + "format": "uri-template" + }, + "authorizations_url": { + "type": "string", + "format": "uri-template" + }, + "code_search_url": { + "type": "string", + "format": "uri-template" + }, + "commit_search_url": { + "type": "string", + "format": "uri-template" + }, + "emails_url": { + "type": "string", + "format": "uri-template" + }, + "emojis_url": { + "type": "string", + "format": "uri-template" + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "feeds_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri-template" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "hub_url": { + "type": "string", + "format": "uri-template" + }, + "issue_search_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "label_search_url": { + "type": "string", + "format": "uri-template" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "organization_url": { + "type": "string", + "format": "uri-template" + }, + "organization_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "organization_teams_url": { + "type": "string", + "format": "uri-template" + }, + "public_gists_url": { + "type": "string", + "format": "uri-template" + }, + "rate_limit_url": { + "type": "string", + "format": "uri-template" + }, + "repository_url": { + "type": "string", + "format": "uri-template" + }, + "repository_search_url": { + "type": "string", + "format": "uri-template" + }, + "current_user_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "starred_gists_url": { + "type": "string", + "format": "uri-template" + }, + "topic_search_url": { + "type": "string", + "format": "uri-template" + }, + "user_url": { + "type": "string", + "format": "uri-template" + }, + "user_organizations_url": { + "type": "string", + "format": "uri-template" + }, + "user_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "user_search_url": { + "type": "string", + "format": "uri-template" + } + }, + "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" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ], + "subcategory": "meta" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/meta", + "title": "Get GitHub Enterprise Server meta information", + "category": "meta", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "verifiable_password_authentication": true, + "packages": [ + "140.82.121.33/32", + "192.30.255.164/31", + "20.200.245.241/32", + "20.233.54.55/32" + ], + "dependabot": [ + "18.213.123.130/32", + "3.217.79.163/32", + "3.217.93.44/32" + ], + "installed_version": "3.8.0" + }, + "schema": { + "title": "Api Overview", + "description": "Api Overview", + "type": "object", + "properties": { + "verifiable_password_authentication": { + "type": "boolean", + "examples": [ + true + ] + }, + "packages": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "13.65.0.0/16", + "157.55.204.33/32", + "2a01:111:f403:f90c::/62" + ] + }, + "dependabot": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "192.168.7.15/32", + "192.168.7.16/32" + ] + }, + "installed_version": { + "type": "string", + "examples": [ + "3.8.0" + ] + } + }, + "required": [ + "verifiable_password_authentication" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + } + ], + "subcategory": "meta" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/octocat", + "title": "Get Octocat", + "category": "meta", + "parameters": [ + { + "name": "s", + "in": "query", + "description": "The words to show in Octocat's speech bubble
", + "schema": { + "type": "string" + }, + "required": false + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/octocat-stream", + "description": "Response
", + "example": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n", + "schema": { + "type": "string" + } + } + } + ], + "previews": [], + "descriptionHTML": "Get the octocat as ASCII art
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ], + "subcategory": "meta" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/zen", + "title": "Get the Zen of GitHub", + "category": "meta", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "text/plain", + "description": "Example response
", + "example": "Responsive is better than fast", + "schema": { + "type": "string" + } + } + } + ], + "previews": [], + "descriptionHTML": "Get a random sentence from the Zen of GitHub
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ], + "subcategory": "meta" + } + ] + }, + "metrics": { + "statistics": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", + "title": "Get the weekly commit activity", + "category": "metrics", + "subcategory": "statistics", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", + "example": [ + [ + 1302998400, + 1124, + -435 + ] + ], + "schema": { + "type": "array", + "items": { + "title": "Code Frequency Stat", + "description": "Code Frequency Stat", + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
" + }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", + "title": "Get the last year of commit activity", + "category": "metrics", + "subcategory": "statistics", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "days": [ + 0, + 3, + 26, + 20, + 39, + 1, + 0 + ], + "total": 89, + "week": 1336280400 + } + ], + "schema": { + "type": "array", + "items": { + "title": "Commit Activity", + "description": "Commit Activity", + "type": "object", + "properties": { + "days": { + "type": "array", + "items": { + "type": "integer" + }, + "examples": [ + 0, + 3, + 26, + 20, + 39, + 1, + 0 + ] + }, + "total": { + "type": "integer", + "examples": [ + 89 + ] + }, + "week": { + "type": "integer", + "examples": [ + 1336280400 + ] + } + }, + "required": [ + "days", + "total", + "week" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
OK
" + }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/stats/contributors", + "title": "Get all contributor commit activity", + "category": "metrics", + "subcategory": "statistics", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "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 + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Contributor Activity", + "description": "Contributor Activity", + "type": "object", + "properties": { + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "total": { + "type": "integer", + "examples": [ + 135 + ] + }, + "weeks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "w": { + "type": "integer" + }, + "a": { + "type": "integer" + }, + "d": { + "type": "integer" + }, + "c": { + "type": "integer" + } + } + }, + "examples": [ + { + "w": "1367712000", + "a": 6898, + "d": 77, + "c": 10 + } + ] + } + }, + "required": [ + "author", + "total", + "weeks" + ] + } + } + } + } + ], + "previews": [], + "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:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsOK
" + }, + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/stats/participation", + "title": "Get the weekly commit count", + "category": "metrics", + "subcategory": "statistics", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "The array order is oldest week (index 0) to most recent week.
", + "example": { + "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 + ] + }, + "schema": { + "title": "Participation Stats", + "type": "object", + "properties": { + "all": { + "type": "array", + "items": { + "type": "integer" + } + }, + "owner": { + "type": "array", + "items": { + "type": "integer" + } + } + }, + "required": [ + "all", + "owner" + ] + } + } + } + ], + "previews": [], + "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.
The array order is oldest week (index 0) to most recent week.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "The array order is oldest week (index 0) to most recent week.
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/stats/punch_card", + "title": "Get the hourly commit count for each day", + "category": "metrics", + "subcategory": "statistics", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "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.
Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor 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.
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.
A header with no content is returned.
" + } + ] + } + ] + }, + "migrations": { + "orgs": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/migrations", + "title": "List organization migrations", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of 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": "exclude", + "description": "Exclude attributes from the API response to improve performance
", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "type": "string", + "examples": [ + "repositories" + ] + } + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 79, + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00", + "node_id": "MDQ6VXNlcjE=" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Migration", + "description": "A migration.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 79 + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "guid": { + "type": "string", + "examples": [ + "0b989ba4-242f-11e5-81e1-c7b6966d2516" + ] + }, + "state": { + "type": "string", + "examples": [ + "pending" + ] + }, + "lock_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "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" }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "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" + } } }, - "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" - ] + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } - }, - "required": [ - "event", - "created_at", - "updated_at", - "source" + }, + "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" + ] + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octo-org/migrations/79" ] }, - { - "title": "Timeline Committed Event", - "description": "Timeline Committed Event", + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "node_id": { + "type": "string" + }, + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
\nA list of repositories is only returned for export migrations.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/orgs/{org}/migrations", + "title": "Start an organization migration", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "repositories", + "in": "body", + "description": "A list of arrays indicating which repositories should be migrated.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "lock_repositories", + "in": "body", + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
", + "default": false + }, + { + "type": "boolean", + "name": "exclude_metadata", + "in": "body", + "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.
", + "default": false + }, + { + "type": "boolean", + "name": "exclude_git_data", + "in": "body", + "description": "Indicates whether the repository git data should be excluded from the migration.
", + "default": false + }, + { + "type": "boolean", + "name": "exclude_attachments", + "in": "body", + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
", + "default": false + }, + { + "type": "boolean", + "name": "exclude_releases", + "in": "body", + "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).
", + "default": false + }, + { + "type": "boolean", + "name": "exclude_owner_projects", + "in": "body", + "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.
", + "default": false + }, + { + "type": "boolean", + "name": "org_metadata_only", + "in": "body", + "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
", + "default": false + }, + { + "type": "array of strings", + "name": "exclude", + "in": "body", + "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".
Response
", + "example": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + }, + "schema": { + "title": "Migration", + "description": "A migration.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 79 + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "guid": { + "type": "string", + "examples": [ + "0b989ba4-242f-11e5-81e1-c7b6966d2516" + ] + }, + "state": { + "type": "string", + "examples": [ + "pending" + ] + }, + "lock_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "event": { - "type": "string" - }, - "sha": { - "description": "SHA for the commit", - "type": "string", + "id": { + "description": "Unique identifier of the repository", + "type": "integer", "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" + 42 ] }, "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", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "committer": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" ] }, - "message": { - "description": "Message describing the purpose of the commit", + "full_name": { "type": "string", "examples": [ - "Fix #42" + "octocat/Hello-World" ] }, - "tree": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "license": { + "anyOf": [ + { + "type": "null" }, - "url": { - "type": "string", - "format": "uri" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } - }, - "required": [ - "sha", - "url" ] }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - } + "organization": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "sha", - "url", - "html_url" - ] - } + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "verification": { + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "verified": { + "admin": { "type": "boolean" }, - "reason": { - "type": "string" + "pull": { + "type": "boolean" }, - "signature": { - "type": [ - "string", - "null" - ] + "triage": { + "type": "boolean" }, - "payload": { - "type": [ - "string", - "null" - ] + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "verified", - "reason", - "signature", - "payload" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "node_id", - "url", - "html_url", - "author", - "committer", - "tree", - "message", - "parents", - "verification" - ] - }, - { - "title": "Timeline Reviewed Event", - "description": "Timeline Reviewed Event", - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the review", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" + "admin", + "pull", + "push" ] }, - "user": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -263372,1665 +320528,1826 @@ "url" ] }, - "body": { - "description": "The text of the review.", + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" ], "examples": [ - "This looks great." + "This your first repo!" ] }, - "state": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "CHANGES_REQUESTED" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "html_url": { + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "pull_request_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/12" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "_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" + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "submitted_at": { + "events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] }, - "commit_id": { - "description": "A commit SHA for the review.", + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { "type": "string", "examples": [ - "54bb654c9e6025347f57900a4a5c2313a96b8035" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "body_html": { - "type": "string" + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] }, - "body_text": { - "type": "string" + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] }, - "author_association": { - "title": "author_association", + "git_url": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" ], + "format": "uri", "examples": [ - "OWNER" + "git:git.example.com/octocat/Hello-World" ] - } - }, - "required": [ - "event", - "id", - "node_id", - "user", - "body", - "state", - "commit_id", - "html_url", - "pull_request_url", - "_links", - "author_association" - ] - }, - { - "title": "Timeline Line Commented Event", - "description": "Timeline Line Commented Event", - "type": "object", - "properties": { - "event": { - "type": "string" }, - "node_id": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, - "comments": { + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { "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", - "type": "string", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - ] - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ], - "examples": [ - 42 - ] - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string", - "examples": [ - "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" - ] - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string", - "examples": [ - "@@ -16,33 +16,40 @@ public class Connection : IConnection..." - ] - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string", - "examples": [ - "config/database.yaml" - ] - }, - "position": { - "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", - "type": "integer", - "examples": [ - 1 - ] - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", - "type": "integer", - "examples": [ - 4 - ] - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string", - "examples": [ - "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" - ] - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer", - "examples": [ - 8 - ] - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string", - "examples": [ - "We should probably include a check for null values here." - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri", - "examples": [ - "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", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" - ] - } - }, - "required": [ - "href" - ] - }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" - ] - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/1" - ] - } - }, - "required": [ - "href" - ] - } + "maintain": { + "type": "boolean" }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment.", - "examples": [ - 2 - ] - }, - "original_start_line": { - "type": [ - "integer", - "null" - ], - "description": "The first line of the range for a multi-line comment.", - "examples": [ - 2 - ] - }, - "start_side": { - "type": [ - "string", - "null" - ], - "description": "The side of the first line of the range for a multi-line comment.", - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer", - "examples": [ - 2 - ] - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer", - "examples": [ - 2 - ] - }, - "side": { - "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", - "enum": [ - "LEFT", - "RIGHT" - ], - "default": "RIGHT", - "type": "string" - }, - "reactions": { - "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" - } + "push": { + "type": "boolean" }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "body_html": { - "type": "string", - "examples": [ - "\"comment body
\"" - ] - }, - "body_text": { - "type": "string", - "examples": [ - "\"comment body\"" - ] + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } } }, - "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" - ] + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } } - } - } - }, - { - "title": "Timeline Commit Commented Event", - "description": "Timeline Commit Commented Event", - "type": "object", - "properties": { - "event": { - "type": "string" }, - "node_id": { + "temp_clone_token": { "type": "string" }, - "commit_id": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { "type": "string" }, - "comments": { - "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", - "null" - ] - }, - "position": { - "type": [ - "integer", - "null" - ] - }, - "line": { - "type": [ - "integer", - "null" - ] - }, - "commit_id": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "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" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "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" + ] + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octo-org/migrations/79" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "node_id": { + "type": "string" + }, + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Initiates the generation of a migration archive.
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/migrations/{migration_id}", + "title": "Get an organization migration status", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance
", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "type": "string", + "examples": [ + "repositories" + ] + } + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.Fetches the status of a migration.
\nThe state of a migration can be one of the following values:
pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", + "title": "Download an organization migration archive", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID" + } + }, + "response": { + "statusCode": "302", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Fetches the URL to a migration archive.
", + "statusCodes": [ + { + "httpStatusCode": "302", + "description": "Found
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", + "title": "Delete an organization migration archive", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID" } + }, + "response": { + "statusCode": "204", + "description": "Response
" } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "204", + "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + "title": "Unlock an organization repository", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "httpStatusCode": "410", - "description": "Gone
" + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repo_name", + "description": "repo_name parameter
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID", + "repo_name": "REPO_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" } ] - } - ] - }, - "licenses": { - "licenses": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/licenses", - "title": "Get all commonly used licenses", - "category": "licenses", + "requestPath": "/orgs/{org}/migrations/{migration_id}/repositories", + "title": "List repositories in an organization migration", + "category": "migrations", + "subcategory": "orgs", "parameters": [ { - "name": "featured", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, "schema": { - "type": "boolean" - }, - "description": "" + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } }, { "name": "per_page", @@ -266323,13 +323829,17 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID" + } }, "response": { "statusCode": "200", @@ -266337,1871 +323847,4990 @@ "description": "Response
", "example": [ { - "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==" + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } } ], "schema": { "type": "array", "items": { - "title": "License Simple", - "description": "License Simple", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "key": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", "examples": [ - "mit" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", "examples": [ - "MIT License" + "Hello-World" ] }, - "url": { + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", "format": "uri", "examples": [ - "https://api.github.com/licenses/mit" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "spdx_id": { + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "MIT" + "2011-01-26T19:06:43Z" ] }, - "node_id": { - "type": "string", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "2011-01-26T19:01:12Z" ] }, - "html_url": { + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - } - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - } - ], - "subcategory": "licenses" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/licenses/{license}", - "title": "Get a license", - "category": "licenses", - "parameters": [ - { - "name": "license", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "license": "LICENSE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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 - }, - "schema": { - "title": "License", - "description": "License", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://choosealicense.com/licenses/mit/" - ] - }, - "description": { - "type": "string", - "examples": [ - "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", - "examples": [ - "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", - "items": { + "examples": [ + "admin" + ] + }, + "temp_clone_token": { "type": "string" }, - "examples": [ - "commercial-use", - "modifications", - "distribution", - "sublicense", - "private-use" - ] - }, - "conditions": { - "type": "array", - "items": { - "type": "string" + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } }, - "examples": [ - "include-copyright" - ] - }, - "limitations": { - "type": "array", - "items": { - "type": "string" + "forks": { + "type": "integer", + "examples": [ + 0 + ] }, - "examples": [ - "no-liability" - ] - }, - "body": { - "type": "string", - "examples": [ - "\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" - ] + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + } }, - "featured": { - "type": "boolean", - "examples": [ - true - ] - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id", - "html_url", - "description", - "implementation", - "permissions", - "conditions", - "limitations", - "body", - "featured" - ] + "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" + ] + } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "List all the repositories for this organization migration.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, { "httpStatusCode": "404", "description": "Resource not found
" } - ], - "subcategory": "licenses" - }, + ] + } + ], + "users": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/license", - "title": "Get the license for a repository", - "category": "licenses", + "requestPath": "/user/migrations", + "title": "List user migrations", + "category": "migrations", + "subcategory": "users", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 1 } } ], "bodyParameters": [], - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } + "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": { - "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==" - } - }, - "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", - "null" - ], - "format": "uri" - }, - "git_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "download_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "type": { - "type": "string" - }, - "content": { - "type": "string" - }, - "encoding": { - "type": "string" + "example": [ + { + "id": 79, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "_links": { - "type": "object", - "properties": { - "git": { - "type": [ - "string", - "null" - ], - "format": "uri" + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "html": { - "type": [ - "string", - "null" - ], - "format": "uri" + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true }, - "self": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "git", - "html", - "self" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" }, - { - "title": "License Simple", - "description": "License Simple", + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00", + "node_id": "MDQ6VXNlcjE=" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Migration", + "description": "A migration.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 79 + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "guid": { + "type": "string", + "examples": [ + "0b989ba4-242f-11e5-81e1-c7b6966d2516" + ] + }, + "state": { + "type": "string", + "examples": [ + "pending" + ] + }, + "lock_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "key": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", + "format": "uri", "examples": [ - "mit" + "https://github.com/octocat/Hello-World" ] }, - "name": { - "type": "string", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - "MIT License" + "This your first repo!" ] }, + "fork": { + "type": "boolean" + }, "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { "type": [ "string", "null" ], "format": "uri", "examples": [ - "https://api.github.com/licenses/mit" + "git:git.example.com/octocat/Hello-World" ] }, - "spdx_id": { + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { "type": [ "string", "null" ], + "format": "uri", "examples": [ - "MIT" + "https://github.com" ] }, - "node_id": { + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "master" ] }, - "html_url": { + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", - "format": "uri" + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ - "key", + "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", - "spdx_id", - "node_id" + "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": [ - "_links", - "git_url", - "html_url", - "download_url", - "name", - "path", - "sha", - "size", - "type", - "url", - "content", - "encoding", - "license" - ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octo-org/migrations/79" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "node_id": { + "type": "string" + }, + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ] + } } } } ], "previews": [], - "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.
", + "descriptionHTML": "Lists all migrations a user has started.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" } - ], - "subcategory": "licenses" - } - ] - }, - "markdown": { - "markdown": [ + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/markdown", - "title": "Render a Markdown document", - "category": "markdown", + "requestPath": "/user/migrations", + "title": "Start a user migration", + "category": "migrations", + "subcategory": "users", "parameters": [], "bodyParameters": [ { - "type": "string", - "name": "text", + "type": "boolean", + "name": "lock_repositories", "in": "body", - "description": "The Markdown text to render in HTML.
", - "isRequired": true + "description": "Lock the repositories being migrated at the start of the migration
" }, { - "type": "string", - "name": "mode", + "type": "boolean", + "name": "exclude_metadata", "in": "body", - "description": "The rendering mode.
", - "enum": [ - "markdown", - "gfm" - ], - "default": "markdown" + "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.
" }, { - "type": "string", - "name": "context", + "type": "boolean", + "name": "exclude_git_data", "in": "body", - "description": "The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.
Example response
", - "example": "Hello world
", - "schema": { - "type": "string" - } - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ + "description": "Indicates whether the repository git data should be excluded from the migration.
" + }, { - "httpStatusCode": "200", - "description": "OK
" + "type": "boolean", + "name": "exclude_attachments", + "in": "body", + "description": "Do not include attachments in the migration
" }, { - "httpStatusCode": "304", - "description": "Not modified
" - } - ], - "subcategory": "markdown" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/markdown/raw", - "title": "Render a Markdown document in raw mode", - "category": "markdown", - "parameters": [], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ + "type": "boolean", + "name": "exclude_releases", + "in": "body", + "description": "Do not include releases in the migration
" + }, { - "key": "default", - "request": { - "contentType": "text/plain", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "text": "Hello **world**" - } - }, - "response": { - "statusCode": "200", - "contentType": "text/html", - "description": "Example response
", - "example": "Hello world
", - "schema": { - "type": "string" - } - } + "type": "boolean", + "name": "exclude_owner_projects", + "in": "body", + "description": "Indicates whether projects owned by the organization or users should be excluded.
" }, { - "key": "default", - "request": { - "contentType": "text/x-markdown", - "description": "Rendering markdown", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "text": "Hello **world**" - } - }, - "response": { - "statusCode": "200", - "contentType": "text/html", - "description": "Example response
", - "example": "Hello world
", - "schema": { - "type": "string" - } - } - } - ], - "previews": [], - "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.
Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
", + "default": false + }, { - "httpStatusCode": "200", - "description": "OK
" + "type": "array of strings", + "name": "exclude", + "in": "body", + "description": "Exclude attributes from the API response to improve performance
" }, { - "httpStatusCode": "304", - "description": "Not modified
" + "type": "array of strings", + "name": "repositories", + "in": "body", + "description": "", + "isRequired": true } ], - "subcategory": "markdown" - } - ] - }, - "meta": { - "meta": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/", - "title": "GitHub API Root", - "category": "meta", - "parameters": [], - "bodyParameters": [], - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", "contentType": "application/json", - "description": "Response
", - "example": { - "current_user_url": "https://api.github.com/user", - "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}", - "authorizations_url": "https://api.github.com/authorizations", - "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}", - "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}", - "emails_url": "https://api.github.com/user/emails", - "emojis_url": "https://api.github.com/emojis", - "events_url": "https://api.github.com/events", - "feeds_url": "https://api.github.com/feeds", - "followers_url": "https://api.github.com/user/followers", - "following_url": "https://api.github.com/user/following{/target}", - "gists_url": "https://api.github.com/gists{/gist_id}", - "hub_url": "https://api.github.com/hub", - "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}", - "issues_url": "https://api.github.com/issues", - "keys_url": "https://api.github.com/user/keys", - "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}", - "notifications_url": "https://api.github.com/notifications", - "organization_url": "https://api.github.com/orgs/{org}", - "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}", - "organization_teams_url": "https://api.github.com/orgs/{org}/teams", - "public_gists_url": "https://api.github.com/gists/public", - "rate_limit_url": "https://api.github.com/rate_limit", - "repository_url": "https://api.github.com/repos/{owner}/{repo}", - "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}", - "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}", - "starred_url": "https://api.github.com/user/starred{/owner}{/repo}", - "starred_gists_url": "https://api.github.com/gists/starred", - "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}", - "user_url": "https://api.github.com/users/{user}", - "user_organizations_url": "https://api.github.com/user/orgs", - "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}", - "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}" - }, - "schema": { - "type": "object", - "properties": { - "current_user_url": { - "type": "string", - "format": "uri-template" - }, - "current_user_authorizations_html_url": { - "type": "string", - "format": "uri-template" - }, - "authorizations_url": { - "type": "string", - "format": "uri-template" - }, - "code_search_url": { - "type": "string", - "format": "uri-template" - }, - "commit_search_url": { - "type": "string", - "format": "uri-template" - }, - "emails_url": { - "type": "string", - "format": "uri-template" - }, - "emojis_url": { - "type": "string", - "format": "uri-template" - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "feeds_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri-template" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "hub_url": { - "type": "string", - "format": "uri-template" - }, - "issue_search_url": { - "type": "string", - "format": "uri-template" - }, - "issues_url": { - "type": "string", - "format": "uri-template" - }, - "keys_url": { - "type": "string", - "format": "uri-template" - }, - "label_search_url": { - "type": "string", - "format": "uri-template" - }, - "notifications_url": { - "type": "string", - "format": "uri-template" - }, - "organization_url": { - "type": "string", - "format": "uri-template" - }, - "organization_repositories_url": { - "type": "string", - "format": "uri-template" - }, - "organization_teams_url": { - "type": "string", - "format": "uri-template" - }, - "public_gists_url": { - "type": "string", - "format": "uri-template" - }, - "rate_limit_url": { - "type": "string", - "format": "uri-template" - }, - "repository_url": { - "type": "string", - "format": "uri-template" - }, - "repository_search_url": { - "type": "string", - "format": "uri-template" - }, - "current_user_repositories_url": { - "type": "string", - "format": "uri-template" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "starred_gists_url": { - "type": "string", - "format": "uri-template" - }, - "topic_search_url": { - "type": "string", - "format": "uri-template" - }, - "user_url": { - "type": "string", - "format": "uri-template" - }, - "user_organizations_url": { - "type": "string", - "format": "uri-template" - }, - "user_repositories_url": { - "type": "string", - "format": "uri-template" - }, - "user_search_url": { - "type": "string", - "format": "uri-template" - } - }, - "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" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "subcategory": "meta" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/meta", - "title": "Get GitHub Enterprise Server meta information", - "category": "meta", - "parameters": [], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "repositories": [ + "octocat/Hello-World" + ], + "lock_repositories": true + } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { - "verifiable_password_authentication": true, - "packages": [ - "192.30.252.0/22" - ], - "dependabot": [ - "54.158.161.132" + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } ], - "installed_version": "3.3.0" + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" }, "schema": { - "title": "Api Overview", - "description": "Api Overview", + "title": "Migration", + "description": "A migration.", "type": "object", "properties": { - "verifiable_password_authentication": { - "type": "boolean", - "examples": [ - true - ] - }, - "packages": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "13.65.0.0/16", - "157.55.204.33/32", - "2a01:111:f403:f90c::/62" - ] - }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, + "id": { + "type": "integer", "examples": [ - "192.168.7.15/32", - "192.168.7.16/32" + 79 ] }, - "installed_version": { - "type": "string", - "examples": [ - "3.3.0" - ] - } - }, - "required": [ - "verifiable_password_authentication" - ] - } - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - } - ], - "subcategory": "meta" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/octocat", - "title": "Get Octocat", - "category": "meta", - "parameters": [ - { - "name": "s", - "in": "query", - "description": "The words to show in Octocat's speech bubble
", - "schema": { - "type": "string" - }, - "required": false - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/octocat-stream", - "description": "Response
", - "example": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n", - "schema": { - "type": "string" - } - } - } - ], - "previews": [], - "descriptionHTML": "Get the octocat as ASCII art
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "subcategory": "meta" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/zen", - "title": "Get the Zen of GitHub", - "category": "meta", - "parameters": [], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "text/plain", - "description": "Example response
", - "example": "Responsive is better than fast", - "schema": { - "type": "string" - } - } - } - ], - "previews": [], - "descriptionHTML": "Get a random sentence from the Zen of GitHub
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "subcategory": "meta" - } - ] - }, - "metrics": { - "statistics": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", - "title": "Get the weekly commit activity", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", - "example": [ - [ - 1302998400, - 1124, - -435 - ] - ], - "schema": { - "type": "array", - "items": { - "title": "Code Frequency Stat", - "description": "Code Frequency Stat", - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
" - }, - { - "httpStatusCode": "202", - "description": "Accepted
" - }, - { - "httpStatusCode": "204", - "description": "A header with no content is returned.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", - "title": "Get the last year of commit activity", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "days": [ - 0, - 3, - 26, - 20, - 39, - 1, - 0 - ], - "total": 89, - "week": 1336280400 - } - ], - "schema": { - "type": "array", - "items": { - "title": "Commit Activity", - "description": "Commit Activity", - "type": "object", - "properties": { - "days": { - "type": "array", - "items": { - "type": "integer" + "owner": { + "anyOf": [ + { + "type": "null" }, - "examples": [ - 0, - 3, - 26, - 20, - 39, - 1, - 0 - ] - }, - "total": { - "type": "integer", - "examples": [ - 89 - ] - }, - "week": { - "type": "integer", - "examples": [ - 1336280400 - ] - } + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "days", - "total", - "week" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
OK
" - }, - { - "httpStatusCode": "202", - "description": "Accepted
" - }, - { - "httpStatusCode": "204", - "description": "A header with no content is returned.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/contributors", - "title": "Get all contributor commit activity", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "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 + "guid": { + "type": "string", + "examples": [ + "0b989ba4-242f-11e5-81e1-c7b6966d2516" + ] }, - "total": 135, - "weeks": [ - { - "w": 1367712000, - "a": 6898, - "d": 77, - "c": 10 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Contributor Activity", - "description": "Contributor Activity", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" + "state": { + "type": "string", + "examples": [ + "pending" + ] + }, + "lock_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, "name": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "full_name": { + "type": "string" }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "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" + } + } }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "private": { + "type": "boolean" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "html_url": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "description": { + "type": "string" }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "fork": { + "type": "boolean" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "archive_url": { + "type": "string" }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "assignees_url": { + "type": "string" }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "blobs_url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "branches_url": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "collaborators_url": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "comments_url": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "commits_url": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" }, "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, - "received_events_url": { + "squash_merge_commit_message": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, - "type": { + "merge_commit_title": { "type": "string", - "examples": [ - "User" - ] + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, - "site_admin": { + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "total": { - "type": "integer", - "examples": [ - 135 - ] - }, - "weeks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "w": { - "type": "integer" - }, - "a": { - "type": "integer" - }, - "d": { - "type": "integer" - }, - "c": { - "type": "integer" } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, - "examples": [ - { - "w": "1367712000", - "a": 6898, - "d": 77, - "c": 10 - } + "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": [ - "author", - "total", - "weeks" - ] - } - } - } - } - ], - "previews": [], - "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:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsOK
" - }, - { - "httpStatusCode": "202", - "description": "Accepted
" - }, - { - "httpStatusCode": "204", - "description": "A header with no content is returned.
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/participation", - "title": "Get the weekly commit count", - "category": "metrics", - "subcategory": "statistics", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "The array order is oldest week (index 0) to most recent week.
", - "example": { - "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 - ] - }, - "schema": { - "title": "Participation Stats", - "type": "object", - "properties": { - "all": { - "type": "array", - "items": { - "type": "integer" - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octo-org/migrations/79" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "node_id": { + "type": "string" }, - "owner": { + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { "type": "array", - "items": { - "type": "integer" - } + "items": {} } }, "required": [ - "all", - "owner" + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" ] } } } ], "previews": [], - "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.
The array order is oldest week (index 0) to most recent week.
", + "descriptionHTML": "Initiates the generation of a user migration archive.
", "statusCodes": [ { - "httpStatusCode": "200", - "description": "The array order is oldest week (index 0) to most recent week.
" + "httpStatusCode": "201", + "description": "Created
" }, { - "httpStatusCode": "404", - "description": "Resource not found
" + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/stats/punch_card", - "title": "Get the hourly commit count for each day", - "category": "metrics", - "subcategory": "statistics", + "requestPath": "/user/migrations/{migration_id}/archive", + "title": "Download a user migration archive", + "category": "migrations", + "subcategory": "users", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", + "name": "migration_id", + "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [], + "previews": [], + "descriptionHTML": "Fetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:
The archive will also contain an attachments directory that includes all attachment files uploaded to GitHub.com and a repositories directory that contains the repository's Git data.
Found
" }, { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.
", + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/user/migrations/{migration_id}/repositories", + "title": "List repositories for a user migration", + "category": "migrations", + "subcategory": "users", + "parameters": [ + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of 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 } } ], "bodyParameters": [], - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", @@ -268209,55 +328838,936 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", - "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.
Response
", "example": [ - [ - 0, - 0, - 5 - ], - [ - 0, - 1, - 43 - ], - [ - 0, - 2, - 21 - ] + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } + } ], "schema": { "type": "array", "items": { - "title": "Code Frequency Stat", - "description": "Code Frequency Stat", - "type": "array", - "items": { - "type": "integer" - } + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + } + }, + "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" + ] } } } } ], "previews": [], - "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor 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.
Lists all the repositories for this user migration.
", "statusCodes": [ { "httpStatusCode": "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.
OK
" }, { - "httpStatusCode": "204", - "description": "A header with no content is returned.
" + "httpStatusCode": "404", + "description": "Resource not found
" } ] } @@ -268575,7 +330085,7 @@ } ], "previews": [], - "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\"].
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\"].
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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -268947,7 +330457,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -269406,6 +330916,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -269494,6 +331012,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -269557,14 +331083,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -269815,7 +331333,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -270282,6 +331800,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -270370,6 +331896,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -270433,10 +331967,901 @@ "read", "write" ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "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", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "account": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ + "permissions", + "repository_selection", + "single_file_name", + "repositories_url", + "account" + ] + } + ] + }, + "expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "app", + "id", + "note", + "note_url", + "scopes", + "token", + "hashed_token", + "token_last_eight", + "fingerprint", + "url", + "created_at", + "updated_at", + "expires_at" + ] + } + } + } + ], + "previews": [], + "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.
You 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.
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "410", + "description": "Gone
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "subcategory": "oauth-authorizations" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/authorizations/clients/{client_id}", + "title": "Get-or-create an authorization for a specific app", + "category": "oauth-authorizations", + "parameters": [ + { + "name": "client_id", + "in": "path", + "required": true, + "description": "The client ID of the OAuth app.
", + "schema": { + "type": "string" + }, + "examples": { + "default": { + "value": "abcde12345fghij67890" + } + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "client_secret", + "in": "body", + "description": "The OAuth app client secret for which to create the token.
", + "isRequired": true + }, + { + "type": "array of strings or null", + "name": "scopes", + "in": "body", + "description": "A list of scopes that this authorization is in.
" + }, + { + "type": "string", + "name": "note", + "in": "body", + "description": "A note to remind you what the OAuth token is for.
" + }, + { + "type": "string", + "name": "note_url", + "in": "body", + "description": "A URL to remind you what app the OAuth token is for.
" + }, + { + "type": "string", + "name": "fingerprint", + "in": "body", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
" + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "response-if-returning-an-existing-token", + "request": { + "contentType": "application/json", + "description": "Create an authorization for an app 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, + "parameters": { + "client_id": "abcde12345fghij67890" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "if returning an existing token
", + "example": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": [ + "public_repo" + ], + "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", + "token_last_eight": "Ae178B4a", + "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", + "expires_at": "2011-10-06T17:26:27Z", + "fingerprint": "" + }, + "schema": { + "title": "Authorization", + "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": [ + "string", + "null" + ] + }, + "hashed_token": { + "type": [ + "string", + "null" + ] + }, + "app": { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "client_id", + "name", + "url" + ] + }, + "note": { + "type": [ + "string", + "null" + ] + }, + "note_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "fingerprint": { + "type": [ + "string", + "null" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "installation": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Scoped Installation", + "type": "object", + "properties": { + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user-to-server access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] }, - "content_references": { + "checks": { "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" @@ -270687,100 +333112,12 @@ ] } } - } - ], - "previews": [], - "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.
You 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.
", - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Created
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "410", - "description": "Gone
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "subcategory": "oauth-authorizations" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/authorizations/clients/{client_id}", - "title": "Get-or-create an authorization for a specific app", - "category": "oauth-authorizations", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "The client ID of the OAuth app.
", - "schema": { - "type": "string" - }, - "examples": { - "default": { - "value": "abcde12345fghij67890" - } - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "client_secret", - "in": "body", - "description": "The OAuth app client secret for which to create the token.
", - "isRequired": true - }, - { - "type": "array of strings or null", - "name": "scopes", - "in": "body", - "description": "A list of scopes that this authorization is in.
" }, { - "type": "string", - "name": "note", - "in": "body", - "description": "A note to remind you what the OAuth token is for.
" - }, - { - "type": "string", - "name": "note_url", - "in": "body", - "description": "A URL to remind you what app the OAuth token is for.
" - }, - { - "type": "string", - "name": "fingerprint", - "in": "body", - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
" - } - ], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "response-if-returning-an-existing-token", + "key": "default", "request": { "contentType": "application/json", - "description": "Create an authorization for an app 1: Status Code 200", + "description": "Create an authorization for an app 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", @@ -270795,9 +333132,9 @@ } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", - "description": "if returning an existing token
", + "description": "Deprecation Notice: GitHub 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.
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -270817,7 +333154,7 @@ "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2011-10-06T17:26:27Z", - "fingerprint": "" + "fingerprint": "jklmnop12345678" }, "schema": { "title": "Authorization", @@ -271173,6 +333510,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -271261,6 +333606,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -271324,14 +333677,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -271578,12 +333923,103 @@ ] } } + } + ], + "previews": [], + "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.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "if returning an existing token
" }, { - "key": "default", + "httpStatusCode": "201", + "description": "Deprecation Notice: GitHub 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.
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "subcategory": "oauth-authorizations" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", + "title": "Get-or-create an authorization for a specific app and fingerprint", + "category": "oauth-authorizations", + "parameters": [ + { + "name": "client_id", + "in": "path", + "required": true, + "description": "The client ID of the OAuth app.
", + "schema": { + "type": "string" + }, + "examples": { + "default": { + "value": "abcde12345fghij67890" + } + } + }, + { + "name": "fingerprint", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "" + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "client_secret", + "in": "body", + "description": "The OAuth app client secret for which to create the token.
", + "isRequired": true + }, + { + "type": "array of strings or null", + "name": "scopes", + "in": "body", + "description": "A list of scopes that this authorization is in.
" + }, + { + "type": "string", + "name": "note", + "in": "body", + "description": "A note to remind you what the OAuth token is for.
" + }, + { + "type": "string", + "name": "note_url", + "in": "body", + "description": "A URL to remind you what app the OAuth token is for.
" + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Create an authorization for an app 2: Status Code 201", + "description": "Create an authorization for an app and fingerprint 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", @@ -271594,13 +334030,14 @@ "note_url": "http://optional/note/url" }, "parameters": { - "client_id": "abcde12345fghij67890" + "client_id": "abcde12345fghij67890", + "fingerprint": "FINGERPRINT" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", - "description": "Deprecation Notice: GitHub 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.
", + "description": "if returning an existing token
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -271976,6 +334413,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -272064,6 +334509,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -272127,14 +334580,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -272381,103 +334826,12 @@ ] } } - } - ], - "previews": [], - "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.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "if returning an existing token
" - }, - { - "httpStatusCode": "201", - "description": "Deprecation Notice: GitHub 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.
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "subcategory": "oauth-authorizations" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", - "title": "Get-or-create an authorization for a specific app and fingerprint", - "category": "oauth-authorizations", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "The client ID of the OAuth app.
", - "schema": { - "type": "string" - }, - "examples": { - "default": { - "value": "abcde12345fghij67890" - } - } - }, - { - "name": "fingerprint", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "" - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "client_secret", - "in": "body", - "description": "The OAuth app client secret for which to create the token.
", - "isRequired": true - }, - { - "type": "array of strings or null", - "name": "scopes", - "in": "body", - "description": "A list of scopes that this authorization is in.
" }, { - "type": "string", - "name": "note", - "in": "body", - "description": "A note to remind you what the OAuth token is for.
" - }, - { - "type": "string", - "name": "note_url", - "in": "body", - "description": "A URL to remind you what app the OAuth token is for.
" - } - ], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "response-if-returning-an-existing-token", + "key": "default", "request": { "contentType": "application/json", - "description": "Create an authorization for an app and fingerprint 1: Status Code 200", + "description": "Create an authorization for an app and fingerprint 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", @@ -272493,9 +334847,9 @@ } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", - "description": "if returning an existing token
", + "description": "Response if returning a new token
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -272514,7 +334868,7 @@ "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", - "expires_at": "2011-10-06T17:26:27Z", + "expires_at": "2012-10-06T17:26:27Z", "fingerprint": "jklmnop12345678" }, "schema": { @@ -272871,6 +335225,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -272959,805 +335321,9 @@ "write" ] }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "account": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - }, - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Create an authorization for an app and fingerprint 2: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", - "scopes": [ - "public_repo" - ], - "note": "optional note", - "note_url": "http://optional/note/url" - }, - "parameters": { - "client_id": "abcde12345fghij67890", - "fingerprint": "FINGERPRINT" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response if returning a new token
", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "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", - "expires_at": "2012-10-06T17:26:27Z", - "fingerprint": "jklmnop12345678" - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { + "organization_announcement_banners": { "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", "enum": [ "read", "write" @@ -273826,14 +335392,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -274083,7 +335641,7 @@ } ], "previews": [], - "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.
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.\"
", + "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.
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.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -274508,6 +336066,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -274596,6 +336162,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -274659,14 +336233,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -274916,7 +336482,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -275392,6 +336958,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -275480,6 +337054,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -275543,14 +337125,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -275800,7 +337374,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -275849,7 +337423,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -276035,7 +337609,7 @@ } ], "previews": [], - "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.
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.
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.
GitHub 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.\"
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.
GitHub 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.\"
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+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" + "description": "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+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "boolean", "name": "members_can_create_private_repositories", "in": "body", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "boolean", "name": "members_can_create_public_repositories", "in": "body", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "string", @@ -276634,11 +338283,73 @@ "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
", "default": true }, + { + "type": "boolean", + "name": "members_can_fork_private_repositories", + "in": "body", + "description": "Whether organization members can fork private organization repositories.
", + "default": false + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "in": "body", + "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
", + "default": false + }, { "type": "string", "name": "blog", "in": "body", "description": "" + }, + { + "type": "boolean", + "name": "advanced_security_enabled_for_new_repositories", + "in": "body", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot alerts is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot security updates is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether dependency graph is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning push protection is automatically enabled for new repositories.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
" + }, + { + "type": "string", + "name": "secret_scanning_push_protection_custom_link", + "in": "body", + "description": "If secret_scanning_push_protection_custom_link_enabled is true, the URL that will be displayed to contributors who are blocked from pushing a secret.
A search phrase. For more information, see Searching the audit log.
", + "description": "A search phrase. For more information, see Searching the audit log.
", "in": "query", "required": false, "schema": { "type": "string" } }, + { + "name": "include", + "description": "The event types to include:
\nweb - returns web (non-Git) events.git - returns Git events.all - returns both web and Git events.The default is web.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -277134,7 +338935,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -277496,7 +339297,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nTo use this endpoint, you must be an organization owner, and you must use an access token with the admin:org scope. GitHub Apps must have the organization_administration read permission to use this endpoint.
By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Resources in the REST API.\"
", + "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nTo use this endpoint, you must be an organization owner, and you must use an access token with the read:audit_log scope. GitHub Apps must have the organization_administration read permission to use this endpoint.
By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Resources in the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -278033,6 +339834,14 @@ "write" ] }, + "repository_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -278121,6 +339930,14 @@ "write" ] }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -278184,14 +340001,6 @@ "read", "write" ] - }, - "content_references": { - "type": "string", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "enum": [ - "read", - "write" - ] } }, "example": { @@ -278467,6 +340276,87 @@ ], "subcategory": "orgs" }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/orgs/{org}/{security_product}/{enablement}", + "title": "Enable or disable a security feature for an organization", + "category": "orgs", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "security_product", + "in": "path", + "description": "The security feature to enable or disable.
", + "required": true, + "schema": { + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "secret_scanning", + "secret_scanning_push_protection" + ] + } + }, + { + "name": "enablement", + "in": "path", + "description": "The action to take.
\nenable_all means to enable the specified security feature for all repositories in the organization.\ndisable_all means to disable the specified security feature for all repositories in the organization.
Action started
" + } + } + ], + "previews": [], + "descriptionHTML": "Enables or disables the specified security feature for all repositories in an organization.
\nTo use this endpoint, you must be an organization owner or be member of a team with the security manager role.\nA token with the 'write:org' scope is also required.
\nGitHub Apps must have the organization_administration:write permission to use this endpoint.
For more information, see \"Managing security managers in your organization.\"
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "Action started
" + }, + { + "httpStatusCode": "422", + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement
" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -278822,7 +340712,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -278832,6 +340722,101 @@ "subcategory": "orgs" } ], + "custom-roles": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/organizations/{organization_id}/custom_roles", + "title": "List custom repository roles in an organization", + "category": "orgs", + "subcategory": "custom-roles", + "parameters": [ + { + "name": "organization_id", + "description": "The unique identifier of the organization.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "organization_id": "ORGANIZATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response - list of custom role names
", + "example": { + "total_count": 2, + "custom_roles": [ + { + "id": 8030, + "name": "Developer" + }, + { + "id": 8031, + "name": "Designer" + } + ] + }, + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of custom roles in this organization", + "type": "integer", + "examples": [ + 3 + ] + }, + "custom_roles": { + "type": "array", + "items": { + "title": "Organization Custom Repository Role", + "description": "Custom repository roles created by organization administrators", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the custom role.", + "type": "integer" + }, + "name": { + "description": "The name of the custom role.", + "type": "string" + } + }, + "required": [ + "id", + "name" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.
\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organization and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.
For more information on custom repository roles, see \"About custom repository roles.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Response - list of custom role names
" + } + ] + } + ], "members": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -280106,7 +342091,7 @@ } ], "previews": [], - "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\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.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -280541,7 +342526,7 @@ } ], "previews": [], - "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.\"
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.\"
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\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "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\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "statusCodes": [ { "httpStatusCode": "202", @@ -282332,7 +344317,7 @@ }, { "httpStatusCode": "403", - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" }, { "httpStatusCode": "404", @@ -282400,6 +344385,291 @@ ] } ], + "security-managers": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/security-managers", + "title": "List security manager teams", + "category": "orgs", + "subcategory": "security-managers", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "schema": { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"
\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the read:org scope.
GitHub Apps must have the administration organization read permission to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", + "title": "Add a security manager team", + "category": "orgs", + "subcategory": "security-managers", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the write:org scope.
GitHub Apps must have the administration organization read-write permission to use this endpoint.
No Content
" + }, + { + "httpStatusCode": "409", + "description": "The organization has reached the maximum number of security manager teams.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}", + "title": "Remove a security manager team", + "category": "orgs", + "subcategory": "security-managers", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Removes the security manager role from a team for an organization. For more information, see \"Managing security managers in your organization team from an organization.\"
\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the admin:org scope.
GitHub Apps must have the administration organization read-write permission to use this endpoint.
No Content
" + } + ] + } + ], "webhooks": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -282637,7 +344907,7 @@ "type": "object", "name": "config", "in": "body", - "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", + "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "isRequired": true, "childParamsGroups": [ { @@ -282654,7 +344924,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.
Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.
Key/value pairs to provide settings for this webhook. These are defined below.
", + "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", @@ -283112,7 +345382,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines what events the hook is triggered for.
", + "description": "Determines what events the hook is triggered for.
", "default": [ "push" ] @@ -283450,7 +345720,7 @@ }, "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@3.3/webhooks/event-payloads/#delivery-headers).", + "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@3.8/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -283527,7 +345797,7 @@ "type": "string", "name": "secret", "in": "body", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
This will trigger a ping event to be sent to the hook.
", + "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", @@ -284882,7 +347152,7 @@ "type": "string or null", "name": "cname", "in": "body", - "description": "Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"
Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "build_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "" + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "build_id": "BUILD_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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" + }, + "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", + "null" + ] + } + }, + "required": [ + "message" + ] + }, + "pusher": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ], + "subcategory": "pages" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "title": "Create a GitHub Pages deployment", "category": "pages", "parameters": [ { @@ -285785,29 +348372,57 @@ "schema": { "type": "string" } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "artifact_url", + "in": "body", + "description": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.
", + "isRequired": true }, { - "name": "build_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "description": "" + "type": "string", + "name": "environment", + "in": "body", + "description": "The target environment for this GitHub Pages deployment.
", + "default": "github-pages" + }, + { + "type": "string", + "name": "pages_build_version", + "in": "body", + "description": "A unique string that represents the version of the build for this deployment.
", + "isRequired": true, + "default": "GITHUB_SHA" + }, + { + "type": "string", + "name": "oidc_token", + "in": "body", + "description": "The OIDC token issued by GitHub Actions certifying the origin of the deployment.
", + "isRequired": true } ], - "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "artifact_url": "https://downloadcontent/", + "environment": "github-pages", + "pages_build_version": "4fd754f7e594640989b406850d0bc8f06a121251", + "oidc_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA", + "preview": false + }, "parameters": { "owner": "OWNER", - "repo": "REPO", - "build_id": "BUILD_ID" + "repo": "REPO" } }, "response": { @@ -285815,265 +348430,65 @@ "contentType": "application/json", "description": "Response
", "example": { - "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" + "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", + "page_url": "developer.github.com" }, "schema": { - "title": "Page Build", - "description": "Page Build", + "title": "GitHub Pages", + "description": "The GitHub Pages deployment status.", "type": "object", "properties": { - "url": { + "status_url": { "type": "string", - "format": "uri" - }, - "status": { - "type": "string" - }, - "error": { - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "message" - ] - }, - "pusher": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "description": "The URI to monitor GitHub Pages deployment status.", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" ] }, - "commit": { - "type": "string" - }, - "duration": { - "type": "integer" - }, - "created_at": { + "page_url": { "type": "string", - "format": "date-time" + "description": "The URI to the deployed GitHub Pages.", + "format": "uri", + "examples": [ + "hello-world.github.io" + ] }, - "updated_at": { + "preview_url": { "type": "string", - "format": "date-time" + "description": "The URI to the deployed GitHub Pages preview.", + "format": "uri", + "examples": [ + "monalisa-1231a2312sa32-23sda74.drafts.github.io" + ] } }, "required": [ - "url", - "status", - "error", - "pusher", - "commit", - "duration", - "created_at", - "updated_at" + "status_url", + "page_url" ] } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "Create a GitHub Pages deployment for a repository.
\nUsers must have write permissions. GitHub Apps must have the pages:write permission to use this endpoint.
OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ], "subcategory": "pages" @@ -295496,6 +357911,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -295867,6 +358290,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -295913,6 +358373,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -295925,6 +358425,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -297064,6 +359569,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -297435,6 +359948,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -297481,6 +360031,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -297493,6 +360083,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -298153,7 +360748,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -298227,13 +360822,13 @@ "type": "boolean", "name": "maintainer_can_modify", "in": "body", - "description": "Indicates whether maintainers can modify the pull request.
" + "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "boolean", "name": "draft", "in": "body", - "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
" + "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
" }, { "type": "integer", @@ -300560,6 +363155,9 @@ }, "is_template": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean" } }, "required": [ @@ -301209,6 +363807,9 @@ }, "allow_forking": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean" } }, "required": [ @@ -302016,7 +364617,7 @@ } ], "previews": [], - "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.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "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.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -302085,7 +364686,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Pass the appropriate media type to fetch diff and patch formats.
", + "description": "Pass the appropriate media type to fetch diff and patch formats.
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -304381,6 +366982,9 @@ }, "is_template": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean" } }, "required": [ @@ -305030,6 +367634,9 @@ }, "allow_forking": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean" } }, "required": [ @@ -305837,11 +368444,11 @@ } ], "previews": [], - "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\".
The 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.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "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\".
The 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.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", - "description": "Pass the appropriate media type to fetch diff and patch formats.
" + "description": "Pass the appropriate media type to fetch diff and patch formats.
" }, { "httpStatusCode": "304", @@ -305930,7 +368537,7 @@ "type": "boolean", "name": "maintainer_can_modify", "in": "body", - "description": "Indicates whether maintainers can modify the pull request.
" + "description": "Indicates whether maintainers can modify the pull request.
" } ], "enabledForGitHubApps": true, @@ -308252,6 +370859,9 @@ }, "is_template": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean" } }, "required": [ @@ -308901,6 +371511,9 @@ }, "allow_forking": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean" } }, "required": [ @@ -309708,7 +372321,7 @@ } ], "previews": [], - "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.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
", + "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.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
", "statusCodes": [ { "httpStatusCode": "200", @@ -310563,7 +373176,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -310968,7 +373581,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "200", @@ -311037,7 +373650,7 @@ "type": "string", "name": "expected_head_sha", "in": "body", - "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.
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.
In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.
In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.
Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.
Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.
Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.
Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.
Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.
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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "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.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.
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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -315096,7 +377709,7 @@ } ], "previews": [], - "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.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "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.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -315586,7 +378199,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
", + "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -318487,6 +381100,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -318858,6 +381479,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -318904,6 +381562,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -318916,6 +381614,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -320055,6 +382758,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -320426,6 +383137,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -320472,6 +383220,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -320484,6 +383272,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -321143,7 +383936,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -324013,6 +386806,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -324384,6 +387185,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -324430,6 +387268,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -324442,6 +387320,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -325581,6 +388464,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -325952,6 +388843,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -325998,6 +388926,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -326010,6 +388978,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -327160,7 +390133,7 @@ "type": "string", "name": "event", "in": "body", - "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.
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.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
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 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.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
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 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.
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.
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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -330360,7 +393333,7 @@ } ], "previews": [], - "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", + "descriptionHTML": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -330750,7 +393723,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -331058,7 +394031,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -331666,7 +394639,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -332107,7 +395080,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -332704,7 +395677,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
The unique identifier of the reaction.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "reaction_id": "REACTION_ID" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this blog post.
\nOAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.
No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "410", - "description": "Gone
" - } - ], - "subcategory": "reactions" - }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -332889,7 +395801,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -333196,7 +396108,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -333249,7 +396161,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -333797,7 +396709,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -333925,7 +396837,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -334232,7 +397144,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -334285,7 +397197,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -334833,7 +397745,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -334961,7 +397873,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -335268,7 +398180,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -335325,7 +398237,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -335873,7 +398785,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -336001,7 +398913,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -336308,7 +399220,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -336361,7 +399273,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -336909,7 +399821,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -337037,7 +399949,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -337342,7 +400254,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -337395,7 +400307,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -337941,7 +400853,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -338069,7 +400981,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -338376,7 +401288,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -338708,7 +401620,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -339050,7 +401962,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -339372,7 +402284,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -340191,6 +403103,18 @@ "in": "body", "description": "Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.
Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.
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 secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "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 secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -340993,7 +403917,7 @@ } ], "previews": [], - "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", + "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -342487,7 +405411,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
true to identify the release as a prerelease, false to identify the release as a full release.
Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.
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.
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.
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.
You 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:
application/zip
GitHub 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.
Notes:
\nThis 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.
You 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:
application/zip
GitHub 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.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Lists repositories for the specified organization.
", + "descriptionHTML": "Lists repositories for the specified organization.
\nNote: In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The visibility of the repository. Note: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. 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.
The visibility of the repository. Note: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. 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.
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\".
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\".
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion. The authenticated user must be an organization owner to set this property to true.
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:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repositoryCreates 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:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repositoryThe 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.
Note: In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note: In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
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.
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.
Whether to archive this repository. Note: You cannot unarchive repositories through the API.
", + "description": "Whether to archive this repository. false will unarchive a previously archived repository.
Either true to allow private forks, or false to prevent private forks.
Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", + "descriptionHTML": "Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -360060,8 +423833,8 @@ } ], "previews": [ - "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.
To access repository visibility during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.nebula-preview+jsonThe 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:
application/vnd.github.baptiste-preview+jsonYou 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.
To access repository visibility during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.nebula-preview+jsonThe 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:
application/vnd.github.baptiste-preview+jsonThe account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ref", + "description": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. main)
Response
", + "example": { + "errors": [ + { + "line": 3, + "column": 1, + "kind": "Invalid pattern", + "source": "***/*.rb @monalisa", + "suggestion": "Did you mean `**/*.rb`?", + "message": "Invalid pattern on line 3: Did you mean `**/*.rb`?\n\n ***/*.rb @monalisa\n ^", + "path": ".github/CODEOWNERS" + }, + { + "line": 7, + "column": 7, + "kind": "Invalid owner", + "source": "*.txt docs@", + "suggestion": null, + "message": "Invalid owner on line 7:\n\n *.txt docs@\n ^", + "path": ".github/CODEOWNERS" + } + ] + }, + "schema": { + "title": "CODEOWNERS errors", + "description": "A list of errors found in a repo's CODEOWNERS file", + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "line": { + "description": "The line number where this errors occurs.", + "type": "integer", + "examples": [ + 7 + ] + }, + "column": { + "description": "The column number where this errors occurs.", + "type": "integer", + "examples": [ + 3 + ] + }, + "source": { + "description": "The contents of the line where the error occurs.", + "type": "string", + "examples": [ + "* user" + ] + }, + "kind": { + "description": "The type of error.", + "type": "string", + "examples": [ + "Invalid owner" + ] + }, + "suggestion": { + "description": "Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.", + "type": [ + "string", + "null" + ], + "examples": [ + "The pattern `/` will never match anything, did you mean `*` instead?" + ] + }, + "message": { + "description": "A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).", + "type": "string", + "examples": [ + "Invalid owner on line 7:\n\n * user\n ^" + ] + }, + "path": { + "description": "The path of the file where the error occured.", + "type": "string", + "examples": [ + ".github/CODEOWNERS" + ] + } + }, + "required": [ + "line", + "column", + "kind", + "message", + "path" + ] + } + } + }, + "required": [ + "errors" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "List any syntax errors that are detected in the CODEOWNERS\nfile.
\nFor more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "subcategory": "repos" + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -360406,7 +424347,7 @@ } ], "previews": [], - "descriptionHTML": "You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"
The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.
This endpoint requires write access to the repository by providing either:
\nrepo scope. For more information, see \"Creating a personal access token for the command line\" in the GitHub Help documentation.metadata:read and contents:read&write permissions.This input example shows how you can use the client_payload as a test to debug your workflow.
You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"
The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.
This endpoint requires write access to the repository by providing either:
\nrepo scope. For more information, see \"Creating a personal access token for the command line\" in the GitHub Help documentation.metadata:read and contents:read&write permissions.This input example shows how you can use the client_payload as a test to debug your workflow.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Status information for cache replicas
", + "example": [ + { + "host": "host-1", + "location": "berlin", + "git": [ + { + "sync_status": "in_sync" + }, + { + "last_sync": "2022-01-10T19:33:52Z" + } + ] + }, + { + "host": "host-2", + "location": "chicago", + "git": [ + { + "sync_status": "offline" + }, + { + "last_sync": "2022-01-10T19:34:12Z" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "description": "Status for a cache replica", + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "location": { + "type": "string" + }, + "git": { + "type": "object", + "properties": { + "sync_status": { + "type": "string", + "enum": [ + "offline", + "inactive", + "in_sync", + "not_in_sync" + ] + }, + "last_sync": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "sync_status", + "last_sync" + ] + } + }, + "required": [ + "host", + "location", + "git" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists the status of each repository cache replica.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Status information for cache replicas
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "subcategory": "repos" + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -361163,6 +425254,12 @@ "description": "The username or organization name the repository will be transferred to.
", "isRequired": true }, + { + "type": "string", + "name": "new_name", + "in": "body", + "description": "The new name to be given to the repository.
" + }, { "type": "array of integers", "name": "team_ids", @@ -361183,7 +425280,8 @@ "team_ids": [ 12, 345 - ] + ], + "new_name": "octorepo" }, "parameters": { "owner": "OWNER", @@ -361941,6 +426039,9 @@ "has_downloads": { "type": "boolean" }, + "has_discussions": { + "type": "boolean" + }, "archived": { "type": "boolean" }, @@ -362000,6 +426101,12 @@ } } }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, "temp_clone_token": { "type": "string" }, @@ -362100,6 +426207,56 @@ }, "allow_forking": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } } }, "required": [ @@ -362155,7 +426312,7 @@ } ], "previews": [], - "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.
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.
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. If the repository is not public, 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.
OAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repositoryCreates 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. If the repository is not public, 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.
OAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repositoryCreating 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:
application/vnd.github.baptiste-preview+jsonCreating 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:
application/vnd.github.baptiste-preview+jsonLists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Creates a new repository for the authenticated user.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repository.Creates a new repository for the authenticated user.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repository.The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
", + "description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.
", "isRequired": true }, { "type": "string", "name": "url_template", "in": "body", - "description": "The URL must contain <num> for the reference number.
The URL must contain <num> for the reference number. <num> matches different characters depending on the value of is_alphanumeric.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files 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.
\nNotes:
\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\".
\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.
The 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.
If 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.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files 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.
\nNotes:
\nIf the requested file's size is:
\nraw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.The 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\".
\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.
The 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.
If 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.
Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the workflow scope to use this endpoint.
Note: If you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
", + "descriptionHTML": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the workflow scope to use this endpoint.
Note: If you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -372631,7 +437214,7 @@ } ], "previews": [], - "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.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note: If you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
", + "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.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note: If you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -372840,7 +437423,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -373052,7 +437635,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -373919,6 +438502,9 @@ "has_downloads": { "type": "boolean" }, + "has_discussions": { + "type": "boolean" + }, "archived": { "type": "boolean" }, @@ -373978,6 +438564,12 @@ } } }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, "temp_clone_token": { "type": "string" }, @@ -374078,6 +438670,56 @@ }, "allow_forking": { "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } } }, "required": [ @@ -374179,6 +438821,18 @@ "name": "organization", "in": "body", "description": "Optional parameter to specify the organization name if forking into an organization.
" + }, + { + "type": "string", + "name": "name", + "in": "body", + "description": "When forking from an existing repository, a new name for the fork.
" + }, + { + "type": "boolean", + "name": "default_branch_only", + "in": "body", + "description": "When forking from an existing repository, fork with only the default branch.
" } ], "enabledForGitHubApps": true, @@ -374283,6 +438937,7 @@ "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, + "language": null, "forks_count": 9, "forks": 9, "stargazers_count": 80, @@ -374444,6 +439099,7 @@ "delete_branch_on_merge": true, "allow_merge_commit": true, "allow_forking": true, + "web_commit_signoff_required": false, "subscribers_count": 42, "network_count": 0, "organization": { @@ -375292,6 +439948,12 @@ true ] }, + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "type": "boolean" }, @@ -376211,6 +440873,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -376582,6 +441252,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -376628,6 +441335,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -376640,6 +441387,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -376780,12 +441532,70 @@ true ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "examples": [ + "PR_TITLE" + ] + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "examples": [ + "PR_BODY" + ] + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "examples": [ + "PR_TITLE" + ] + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "examples": [ + "PR_BODY" + ] + }, "allow_forking": { "type": "boolean", "examples": [ true ] }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, "subscribers_count": { "type": "integer", "examples": [ @@ -377876,6 +442686,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -378247,6 +443065,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -378293,6 +443148,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -378305,6 +443200,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -379255,6 +444155,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -379626,6 +444534,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -379672,6 +444617,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -379684,6 +444669,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -380027,7 +445017,128 @@ } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Accepted
", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "Enables Git LFS for a repository. Access tokens must have the admin:enterprise scope.
Accepted
" + }, + { + "httpStatusCode": "403", + "description": "We will return a 403 with one of the following messages:
\nThe account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Disables Git LFS for a repository. Access tokens must have the admin:enterprise scope.
No Content
" + } + ] + } + ], + "tags": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/tags/protection", + "title": "List tag protection states for a repository", + "category": "repos", + "subcategory": "tags", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -380040,36 +445151,204 @@ } }, "response": { - "statusCode": "202", + "statusCode": "200", "contentType": "application/json", - "description": "Accepted
", - "example": null, + "description": "Response
", + "example": [ + { + "id": 2, + "pattern": "v1.*" + } + ], "schema": { - "type": "object" + "type": "array", + "items": { + "title": "Tag protection", + "description": "Tag protection", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "created_at": { + "type": "string", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "pattern": { + "type": "string", + "examples": [ + "v1.*" + ] + } + }, + "required": [ + "pattern" + ] + } } } } ], "previews": [], - "descriptionHTML": "Enables Git LFS for a repository. Access tokens must have the admin:enterprise scope.
This returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { - "httpStatusCode": "202", - "description": "Accepted
" + "httpStatusCode": "200", + "description": "OK
" }, { "httpStatusCode": "403", - "description": "We will return a 403 with one of the following messages:
\nForbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/tags/protection", + "title": "Create a tag protection state for a repository", + "category": "repos", + "subcategory": "tags", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "pattern", + "in": "body", + "description": "An optional glob pattern to match against when enforcing tag protection.
", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "pattern": "v1.*" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "enabled": true + }, + "schema": { + "title": "Tag protection", + "description": "Tag protection", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "created_at": { + "type": "string", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "pattern": { + "type": "string", + "examples": [ + "v1.*" + ] + } + }, + "required": [ + "pattern" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/lfs", - "title": "Disable Git LFS for a repository", + "requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}", + "title": "Delete a tag protection state for a repository", "category": "repos", - "subcategory": "lfs", + "subcategory": "tags", "parameters": [ { "name": "owner", @@ -380088,10 +445367,19 @@ "schema": { "type": "string" } + }, + { + "name": "tag_protection_id", + "description": "The unique identifier of the tag protection.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "bodyParameters": [], - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", @@ -380100,7 +445388,8 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "tag_protection_id": "TAG_PROTECTION_ID" } }, "response": { @@ -380110,11 +445399,19 @@ } ], "previews": [], - "descriptionHTML": "Disables Git LFS for a repository. Access tokens must have the admin:enterprise scope.
This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" } ] } @@ -380131,7 +445428,7 @@ "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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.
", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { @@ -380140,7 +445437,7 @@ }, { "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
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
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.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.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.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.
", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { @@ -381180,7 +446536,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by author-date or committer-date. Default: best match
Sorts the results of your query by author-date or committer-date. Default: best match
Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For 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
Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For 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
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. 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.
", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. 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.
", "in": "query", "required": true, "schema": { @@ -382570,7 +447985,7 @@ }, { "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
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
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.
For 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
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server 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.\"
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.
For 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
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server 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.\"
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.
", + "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.
", "in": "query", "required": true, "schema": { @@ -385648,7 +451153,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by when the label was created or updated. Default: best match
Sorts the results of your query by when the label was created or updated. Default: best match
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.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", + "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.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "statusCodes": [ { "httpStatusCode": "200", @@ -385874,7 +451379,7 @@ "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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.
", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { @@ -385883,7 +451388,7 @@ }, { "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
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
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.
For 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
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "subcategory": "search" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/search/topics", + "title": "Search topics", + "category": "search", + "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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query.
", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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 + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "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", + "null" + ] + }, + "short_description": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "created_by": { + "type": [ + "string", + "null" + ] + }, + "released": { + "type": [ + "string", + "null" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "featured": { + "type": "boolean" + }, + "curated": { + "type": "boolean" + }, + "score": { + "type": "number" + }, + "repository_count": { + "type": [ + "integer", + "null" + ] + }, + "logo_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "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" + ] + } + } + } + } + } + } + ], + "previews": [], + "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.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + } + ], + "subcategory": "search" + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/search/users", + "title": "Search users", + "category": "search", + "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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"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
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.
The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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 + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "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", + "null" + ] + }, + "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" }, - "notifications_url": { + "type": { "type": "string" }, - "labels_url": { - "type": "string" + "score": { + "type": "number" }, - "releases_url": { + "following_url": { "type": "string" }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "git_url": { + "gists_url": { "type": "string" }, - "ssh_url": { + "starred_url": { "type": "string" }, - "clone_url": { + "events_url": { "type": "string" }, - "svn_url": { - "type": "string", - "format": "uri" + "public_repos": { + "type": "integer" }, - "forks": { + "public_gists": { "type": "integer" }, - "open_issues": { + "followers": { "type": "integer" }, - "watchers": { + "following": { "type": "integer" }, - "topics": { - "type": "array", - "items": { - "type": "string" - } + "created_at": { + "type": "string", + "format": "date-time" }, - "mirror_url": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "name": { "type": [ "string", "null" - ], - "format": "uri" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" + ] }, - "has_pages": { - "type": "boolean" + "bio": { + "type": [ + "string", + "null" + ] }, - "has_wiki": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ], + "format": "email" }, - "has_downloads": { - "type": "boolean" + "location": { + "type": [ + "string", + "null" + ] }, - "archived": { + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "hireable": { + "type": [ + "boolean", + "null" ] }, "text_matches": { @@ -386632,105 +452908,45 @@ } } }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" + "blog": { + "type": [ + "string", + "null" + ] }, - "allow_forking": { - "type": "boolean" + "company": { + "type": [ + "string", + "null" + ] }, - "is_template": { - "type": "boolean" + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "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", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", "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" ] } @@ -386741,7 +452957,7 @@ } ], "previews": [], - "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.
For 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
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
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, public 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.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query.
", - "in": "query", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", "required": true, "schema": { "type": "string" } }, + { + "name": "state", + "in": "query", + "description": "Set to open or resolved to only list secret scanning alerts in a specific state.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, { "name": "per_page", "description": "The number of results per page (max 100).
", @@ -386788,653 +453067,1238 @@ } }, { - "name": "page", - "description": "Page number of the results to fetch.
", + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" } } ], "bodyParameters": [], - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", - "example": { - "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 + "example": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true }, - { - "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 + "secret_type": "adafruit_io_key", + "secret_type_display_name": "Adafruit IO Key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "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}", + "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}", + "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": "https://api.github.com/repos/octocat/Hello-World/hooks" }, - { - "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 + "push_protection_bypassed_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true }, - { - "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 + "push_protection_bypassed": true, + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "resolution_comment": "Example comment" + }, + { + "number": 1, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret_type_display_name": "Mailchimp API Key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "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}", + "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}", + "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": "https://api.github.com/repos/octocat/Hello-World/hooks" }, - { - "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 - } - ] - }, + "push_protection_bypassed_by": null, + "push_protection_bypassed": false, + "push_protection_bypassed_at": null, + "resolution_comment": null + } + ], "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Topic Search Result Item", - "description": "Topic Search Result Item", + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "resolution": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + null, + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.8/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { + "id": { + "type": "integer", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { - "type": "string" + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] }, - "display_name": { - "type": [ - "string", - "null" + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "short_description": { - "type": [ - "string", - "null" + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, "description": { "type": [ "string", "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" ] }, - "created_by": { - "type": [ - "string", - "null" - ] + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." }, - "released": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "created_at": { + "archive_url": { "type": "string", - "format": "date-time" + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "updated_at": { + "assignees_url": { "type": "string", - "format": "date-time" - }, - "featured": { - "type": "boolean" - }, - "curated": { - "type": "boolean" - }, - "score": { - "type": "number" - }, - "repository_count": { - "type": [ - "integer", - "null" + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "logo_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "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", - "null" - ], - "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" - ] - } - } - } - } - } - } - ], - "previews": [], - "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.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - } - ], - "subcategory": "search" - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/search/users", - "title": "Search users", - "category": "search", - "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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"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
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.
The number of 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 - } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "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 - } - ] - }, - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "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" + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "id": { - "type": "integer" + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] }, - "node_id": { - "type": "string" + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] }, - "avatar_url": { + "comments_url": { "type": "string", - "format": "uri" + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] }, - "gravatar_id": { - "type": [ - "string", - "null" + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "url": { + "compare_url": { "type": "string", - "format": "uri" + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] }, - "html_url": { + "contents_url": { "type": "string", - "format": "uri" + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] }, - "followers_url": { + "contributors_url": { "type": "string", - "format": "uri" + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] }, - "subscriptions_url": { + "deployments_url": { "type": "string", - "format": "uri" + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "organizations_url": { + "downloads_url": { "type": "string", - "format": "uri" + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] }, - "repos_url": { + "events_url": { "type": "string", - "format": "uri" + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] }, - "received_events_url": { + "forks_url": { "type": "string", - "format": "uri" + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] }, - "type": { - "type": "string" + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] }, - "score": { - "type": "number" + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] }, - "following_url": { - "type": "string" + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] }, - "gists_url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] }, - "starred_url": { - "type": "string" + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] }, - "events_url": { - "type": "string" + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] }, - "public_repos": { - "type": "integer" + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] }, - "public_gists": { - "type": "integer" + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] }, - "followers": { - "type": "integer" + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] }, - "following": { - "type": "integer" + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] }, - "created_at": { + "milestones_url": { "type": "string", - "format": "date-time" + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "updated_at": { + "notifications_url": { "type": "string", - "format": "date-time" + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, - "name": { - "type": [ - "string", - "null" + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "bio": { - "type": [ - "string", - "null" + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] }, - "location": { - "type": [ - "string", - "null" + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "site_admin": { - "type": "boolean" + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] }, - "hireable": { - "type": [ - "boolean", - "null" + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "blog": { - "type": [ - "string", - "null" + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" ] }, - "company": { - "type": [ - "string", - "null" + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "score" + "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" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment that was optionally added when this alert was closed" } } } @@ -387443,31 +454307,23 @@ } ], "previews": [], - "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, public 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.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager.
OK
" }, { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" + "httpStatusCode": "404", + "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], - "subcategory": "search" - } - ] - }, - "secret-scanning": { - "secret-scanning": [ + "subcategory": "secret-scanning" + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -387500,7 +454356,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -387515,6 +454371,34 @@ "type": "string" } }, + { + "name": "sort", + "description": "The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, { "name": "page", "description": "Page number of the results to fetch.
", @@ -387532,6 +454416,24 @@ "type": "integer", "default": 30 } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -387671,7 +454573,8 @@ "site_admin": true }, "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z" + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "resolution_comment": "Example comment" }, { "number": 1, @@ -387755,7 +454658,8 @@ }, "push_protection_bypassed_by": null, "push_protection_bypassed": false, - "push_protection_bypassed_at": null + "push_protection_bypassed_at": null, + "resolution_comment": null } ], "schema": { @@ -388006,6 +454910,10 @@ "type": "string", "description": "The type of secret that secret scanning detected." }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.8/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + }, "secret": { "type": "string", "description": "The secret that was detected." @@ -388552,6 +455460,196 @@ "trees_url", "url" ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment that was optionally added when this alert was closed" } } } @@ -388560,7 +455658,7 @@ } ], "previews": [], - "descriptionHTML": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -388633,6 +455731,34 @@ "type": "string" } }, + { + "name": "sort", + "description": "The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, { "name": "page", "description": "Page number of the results to fetch.
", @@ -388650,6 +455776,24 @@ "type": "integer", "default": 30 } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -388723,7 +455867,8 @@ "site_admin": true }, "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z" + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "resolution_comment": "Example comment" }, { "number": 1, @@ -388740,7 +455885,8 @@ "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "push_protection_bypassed_by": null, "push_protection_bypassed": false, - "push_protection_bypassed_at": null + "push_protection_bypassed_at": null, + "resolution_comment": null } ], "schema": { @@ -388987,13 +456133,207 @@ } ] }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, "secret_type": { "type": "string", "description": "The type of secret that secret scanning detected." }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.8/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + }, "secret": { "type": "string", "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." } } } @@ -389002,7 +456342,7 @@ } ], "previews": [], - "descriptionHTML": "Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
An optional comment when closing an alert. Cannot be updated or deleted. Must be null when changing state to open.
Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.
Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.
OK
" }, + { + "httpStatusCode": "400", + "description": "Bad request, resolution comment is invalid or the resolution was not changed.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" }, { "httpStatusCode": "422", - "description": "State does not match the resolution
" + "description": "State does not match the resolution or resolution comment
" }, { "httpStatusCode": "503", @@ -389844,31 +457595,21 @@ } }, { - "type": "commit", + "type": "issue_title", "details": { - "path": "/example/secrets.txt", - "start_line": 5, - "end_line": 5, - "start_column": 1, - "end_column": 64, - "blob_sha": "9def38117ab2d8355b982429aa924e268b4b0065", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065", - "commit_sha": "588483b99a46342501d99e3f10630cfc1219ea32", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32" + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" } }, { - "type": "commit", + "type": "issue_body", "details": { - "path": "/example/secrets.txt", - "start_line": 12, - "end_line": 12, - "start_column": 1, - "end_column": 64, - "blob_sha": "0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", - "commit_sha": "9def38117ab2d8355b982429aa924e268b4b0065", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065" + "issue_body_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + { + "type": "issue_comment", + "details": { + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" } } ], @@ -389881,7 +457622,10 @@ "type": { "type": "string", "enum": [ - "commit" + "commit", + "issue_title", + "issue_body", + "issue_comment" ], "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.", "examples": [ @@ -389951,6 +457695,57 @@ "commit_sha", "commit_url" ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] } ] } @@ -389965,7 +457760,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
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 \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"
" + "description": "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 \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"
" } ], "enabledForGitHubApps": true, @@ -390968,6 +458763,21 @@ true ] }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, "updated_at": { "type": "string", "format": "date-time" @@ -391028,7 +458838,7 @@ } ], "previews": [], - "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.\"
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\".
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.\"
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\".
Gets a team using the team's slug. GitHub Enterprise Server generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "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. 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.\"
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -398738,6 +466769,21 @@ true ] }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, "updated_at": { "type": "string", "format": "date-time" @@ -398798,7 +466844,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -399488,6 +467534,21 @@ true ] }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, "updated_at": { "type": "string", "format": "date-time" @@ -400161,6 +468222,21 @@ true ] }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, "updated_at": { "type": "string", "format": "date-time" @@ -400221,7 +468297,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo 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.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo 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.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -400650,7 +468726,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "statusCodes": [ { "httpStatusCode": "200", @@ -401001,7 +469077,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -402193,6 +470339,7 @@ "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, @@ -402224,6 +470371,7 @@ "triage": false, "pull": true }, + "role_name": "read", "allow_rebase_merge": true, "template_repository": { "id": 1296269, @@ -402489,6 +470637,12 @@ "push" ] }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, "owner": { "anyOf": [ { @@ -403959,6 +472113,14 @@ true ] }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, "archived": { "description": "Whether the repository is archived.", "default": false, @@ -404330,6 +472492,43 @@ "allow_update_branch": { "type": "boolean" }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "type": "boolean" }, @@ -404376,6 +472575,46 @@ false ] }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, @@ -404388,6 +472627,11 @@ "description": "Whether to allow forking this repo", "type": "boolean" }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, "subscribers_count": { "type": "integer" }, @@ -404535,6 +472779,14 @@ false ] }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, "subscribers_count": { "type": "integer" }, @@ -404631,7 +472883,7 @@ } ], "previews": [], - "descriptionHTML": "Note: Repositories inherited through a parent team will also be checked.
\nDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\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:
Note: Repositories inherited through a parent team will also be checked.
\nDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\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:
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
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.\"
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
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.\"
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", @@ -405088,7 +473340,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.
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.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -408977,7 +477244,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
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.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
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.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -412905,7 +481172,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
No Content
" + } + ] + } + ], + "external-groups": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/external-group/{group_id}", + "title": "Get an external group", + "category": "teams", + "subcategory": "external-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "group_id", + "description": "The unique identifier of the group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "group_id": "GROUP_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ], + "members": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + }, + "schema": { + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", + "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name for the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The date when the group was last updated_at", + "type": "string", + "examples": [ + "2021-01-03 22:27:15:000 -700" + ] + }, + "teams": { + "description": "An array of teams linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "type": "integer", + "examples": [ + 1 + ] + }, + "team_name": { + "description": "The name of the team", + "type": "string", + "examples": [ + "team-test" + ] + } + } + }, + "examples": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ] + }, + "members": { + "description": "An array of external members linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "type": "integer", + "examples": [ + 1 + ] + }, + "member_login": { + "description": "The handle/login for the user", + "type": "string", + "examples": [ + "mona-lisa_eocsaxrs" + ] + }, + "member_name": { + "description": "The user display name/profile name", + "type": "string", + "examples": [ + "Mona Lisa" + ] + }, + "member_email": { + "description": "An email attached to a user", + "type": "string", + "examples": [ + "mona_lisa@github.com" + ] + } + } + }, + "examples": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/external-groups", + "title": "List external groups in an organization", + "category": "teams", + "subcategory": "external-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page token
", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "display_name", + "description": "Limits the list to groups containing the text in the group name
", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + }, + "schema": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] + } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", + "title": "List a connection between an external group and a team", + "category": "teams", + "subcategory": "external-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + }, + "schema": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] + } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", + "title": "Update the connection between an external group and a team", + "category": "teams", + "subcategory": "external-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "group_id", + "in": "body", + "description": "External Group Id
", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "group_id": 123 + }, + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ], + "members": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + }, + "schema": { + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", + "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name for the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The date when the group was last updated_at", + "type": "string", + "examples": [ + "2021-01-03 22:27:15:000 -700" + ] + }, + "teams": { + "description": "An array of teams linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "type": "integer", + "examples": [ + 1 + ] + }, + "team_name": { + "description": "The name of the team", + "type": "string", + "examples": [ + "team-test" + ] + } + } + }, + "examples": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ] + }, + "members": { + "description": "An array of external members linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "type": "integer", + "examples": [ + 1 + ] + }, + "member_login": { + "description": "The handle/login for the user", + "type": "string", + "examples": [ + "mona-lisa_eocsaxrs" + ] + }, + "member_name": { + "description": "The user display name/profile name", + "type": "string", + "examples": [ + "Mona Lisa" + ] + }, + "member_email": { + "description": "An email attached to a user", + "type": "string", + "examples": [ + "mona_lisa@github.com" + ] + } + } + }, + "examples": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", + "title": "Remove the connection between an external group and a team", + "category": "teams", + "subcategory": "external-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", @@ -413819,7 +482844,7 @@ } ], "previews": [], - "descriptionHTML": "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: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
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: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\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.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\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.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
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.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
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.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -414347,7 +483372,7 @@ } ], "previews": [], - "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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -414406,7 +483431,7 @@ } ], "previews": [], - "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.\"
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.\"
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.\"
", + "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.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -414574,7 +483599,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam 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:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam 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:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\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.\"
\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.
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\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.\"
\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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -414758,7 +483783,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\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 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.
\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.\"
", + "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\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 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.
\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.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -416794,7 +485819,7 @@ } ], "previews": [], - "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.
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.
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\"
The 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.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", + "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\"
The 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.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "statusCodes": [ { "httpStatusCode": "200", @@ -418640,7 +487665,7 @@ } ], "previews": [], - "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.
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.
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
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.
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.
A descriptive name for the new key.
" + }, { "type": "string", "name": "armored_public_key", @@ -420229,6 +489283,7 @@ "description": "Response
", "example": { "id": 3, + "name": "Octocat's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -420251,7 +489306,8 @@ "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" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -420260,6 +489316,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "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-----\"" }, "schema": { @@ -420273,6 +489330,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "Octocat's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -420362,6 +489428,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -420378,7 +489447,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -420414,6 +489484,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -420434,14 +489510,15 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] } } } ], "previews": [], - "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.
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.
Response
", "example": { "id": 3, + "name": "Octocat's GPG Key", "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", @@ -420527,7 +489605,8 @@ "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" + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false } ], "can_sign": true, @@ -420536,6 +489615,7 @@ "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, "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-----\"" }, "schema": { @@ -420549,6 +489629,15 @@ 3 ] }, + "name": { + "type": [ + "string", + "null" + ], + "examples": [ + "Octocat's GPG Key" + ] + }, "primary_key_id": { "type": [ "integer", @@ -420638,6 +489727,9 @@ "string", "null" ] + }, + "revoked": { + "type": "boolean" } } }, @@ -420654,7 +489746,8 @@ "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", - "expires_at": null + "expires_at": null, + "revoked": false } ] }, @@ -420690,6 +489783,12 @@ ], "format": "date-time" }, + "revoked": { + "type": "boolean", + "examples": [ + true + ] + }, "raw_key": { "type": [ "string", @@ -420710,14 +489809,15 @@ "can_encrypt_storage", "can_certify", "emails", - "subkeys" + "subkeys", + "revoked" ] } } } ], "previews": [], - "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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least read:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/user/ssh_signing_keys", + "title": "Create a SSH signing key for the authenticated user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "title", + "in": "body", + "description": "A descriptive name for the new key.
" + }, + { + "type": "string", + "name": "key", + "in": "body", + "description": "The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"
", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least write:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"
Created
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", + "title": "Get an SSH signing key for the authenticated user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "ssh_signing_key_id": "SSH_SIGNING_KEY_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least read:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"
OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", + "title": "Delete an SSH signing key for the authenticated user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "ssh_signing_key_id": "SSH_SIGNING_KEY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least admin:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"
No Content
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/users/{username}/ssh_signing_keys", + "title": "List SSH signing keys for a user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists the SSH signing keys for a user. This operation is accessible by anyone.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + } ] }, "webhooks": { @@ -421681,7 +491289,7 @@ }, "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@3.3/webhooks/event-payloads/#delivery-headers).", + "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@3.8/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -421767,7 +491375,7 @@ "type": "string", "name": "secret", "in": "body", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Key/value pairs to provide settings for this webhook. These are defined below.
", + "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", @@ -422849,7 +492457,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines what events the hook is triggered for.
", + "description": "Determines what events the hook is triggered for.
", "default": [ "push" ] @@ -423045,7 +492653,7 @@ }, "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@3.3/webhooks/event-payloads/#delivery-headers).", + "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@3.8/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -423353,7 +492961,7 @@ }, "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@3.3/webhooks/event-payloads/#delivery-headers).", + "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@3.8/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -423510,7 +493118,7 @@ "type": "object", "name": "config", "in": "body", - "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", + "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", @@ -423526,7 +493134,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines what events the hook is triggered for. This replaces the entire array of events.
", + "description": "Determines what events the hook is triggered for. This replaces the entire array of events.
", "default": [ "push" ] @@ -423728,7 +493336,7 @@ }, "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@3.3/webhooks/event-payloads/#delivery-headers).", + "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@3.8/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -423974,7 +493582,7 @@ } ], "previews": [], - "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", + "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index a88f732b7b07..fc87586357cc 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -241968,36 +241968,74 @@ "SHA256_ED25519": "+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU" }, "hooks": [ - "192.30.252.0/22" + "192.30.252.0/22", + "185.199.108.0/22", + "140.82.112.0/20", + "143.55.64.0/20", + "2a0a:a440::/29", + "2606:50c0::/32" ], "web": [ "192.30.252.0/22", - "185.199.108.0/22" + "185.199.108.0/22", + "140.82.112.0/20", + "143.55.64.0/20", + "2a0a:a440::/29", + "2606:50c0::/32", + "20.201.28.151/32", + "20.205.243.166/32", + "102.133.202.242/32" ], "api": [ "192.30.252.0/22", - "185.199.108.0/22" + "185.199.108.0/22", + "140.82.112.0/20", + "143.55.64.0/20", + "2a0a:a440::/29", + "2606:50c0::/32", + "20.201.28.148/32" ], "git": [ - "192.30.252.0/22" + "192.30.252.0/22", + "185.199.108.0/22", + "140.82.112.0/20", + "143.55.64.0/20", + "2a0a:a440::/29", + "2606:50c0::/32" ], "packages": [ - "192.30.252.0/22" + "140.82.121.33/32", + "192.30.255.164/31", + "20.200.245.241/32", + "20.233.54.55/32" ], "pages": [ "192.30.252.153/32", - "192.30.252.154/32" + "192.30.252.154/32", + "185.199.108.153/32", + "185.199.109.153/32", + "185.199.110.153/32", + "185.199.111.153/32", + "2606:50c0:8000::153/128", + "2606:50c0:8001::153/128", + "2606:50c0:8002::153/128", + "2606:50c0:8003::153/128" ], "importer": [ - "54.158.161.132", - "54.226.70.38" + "52.23.85.212/32", + "52.0.228.224/32", + "52.22.155.48/32" ], "actions": [ - "13.64.0.0/16", - "13.65.0.0/16" + "4.148.0.0/16", + "13.67.153.64/26", + "2603:1030:804:220::/61", + "2603:1036:2500:10::/64" ], "dependabot": [ - "54.158.161.132" + "18.213.123.130/32", + "3.217.79.163/32", + "3.217.93.44/32" ] }, "schema": { @@ -242124,7 +242162,7 @@ } ], "previews": [], - "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nNote: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
", + "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nNote: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
\nNote: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
", "statusCodes": [ { "httpStatusCode": "200", @@ -243475,6 +243513,7 @@ }, "repositories": { "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", "items": { "title": "Repository", "description": "A repository on GitHub.", @@ -244917,7 +244956,7 @@ } ], "previews": [], - "descriptionHTML": "Lists the most recent migrations.
", + "descriptionHTML": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
\nA list of repositories is only returned for export migrations.
Fetches the status of a migration.
\nThe state of a migration can be one of the following values:
pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.Resource not found
" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", + "title": "Download an organization migration archive", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID" + } + }, + "response": { + "statusCode": "302", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Fetches the URL to a migration archive.
", + "statusCodes": [ + { + "httpStatusCode": "302", + "description": "Found
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", + "title": "Delete an organization migration archive", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + "title": "Unlock an organization repository", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repo_name", + "description": "repo_name parameter
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID", + "repo_name": "REPO_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/migrations/{migration_id}/repositories", + "title": "List repositories in an organization migration", + "category": "migrations", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of 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 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "migration_id": "MIGRATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "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" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "push": { + "type": "boolean" }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "triage": { + "type": "boolean" }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", "examples": [ - false + "contributor_covenant" ] }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", + "name": { + "type": "string", "examples": [ - false + "Contributor Covenant" ] }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", + "url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { + "body": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "# 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" ] }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" } }, "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" + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] } }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octo-org/migrations/79" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" - ] - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "type": "array", - "items": {} - } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] + "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" + ] + } } } } ], "previews": [], - "descriptionHTML": "Fetches the status of a migration.
\nThe state of a migration can be one of the following values:
pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.List all the repositories for this organization migration.
", "statusCodes": [ { "httpStatusCode": "200", - "description": "pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.OK
" }, { "httpStatusCode": "404", @@ -249172,6 +250344,7 @@ }, "repositories": { "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", "items": { "title": "Repository", "description": "A repository on GitHub.", @@ -251094,6 +252267,7 @@ }, "repositories": { "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", "items": { "title": "Repository", "description": "A repository on GitHub.", @@ -321233,7 +322407,7 @@ "contentType": "application/octet-stream", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": "@release-asset.gz", + "bodyParameters": "@example.zip", "parameters": { "owner": "OWNER", "repo": "REPO", @@ -321524,7 +322698,7 @@ } ], "previews": [], - "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.
You 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:
application/zip
GitHub AE 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.
Notes:
\nThis 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.
You 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:
application/zip
GitHub AE 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.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion. The authenticated user must be an organization owner to set this property to true.
Gets a team using the team's slug. GitHub AE generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub AE replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Someone installed a GitHub App on a user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32680,7 +32680,7 @@ }, "deleted": { "descriptionHtml": "Someone uninstalled a GitHub App from their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32783,7 +32783,7 @@ }, "new_permissions_accepted": { "descriptionHtml": "Someone granted new permissions to a GitHub App.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32886,7 +32886,7 @@ }, "suspend": { "descriptionHtml": "Someone blocked access by a GitHub App to their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32989,7 +32989,7 @@ }, "unsuspend": { "descriptionHtml": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -33094,7 +33094,7 @@ "installation_repositories": { "added": { "descriptionHtml": "A GitHub App installation was granted access to one or more repositories.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -33358,7 +33358,7 @@ }, "removed": { "descriptionHtml": "Access to one or more repositories was revoked for a GitHub App installation.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -57202,7 +57202,7 @@ "merge_group": { "default": { "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", - "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in limited private beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -154909,7 +154909,7 @@ "category": "repository" }, "transferred": { - "descriptionHtml": "Ownership of the repository was transferred to a user or organization account.
", + "descriptionHtml": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { diff --git a/lib/webhooks/static/decorated/ghec.json b/lib/webhooks/static/decorated/ghec.json index b68d7632ca2b..0d2b56e7dc28 100644 --- a/lib/webhooks/static/decorated/ghec.json +++ b/lib/webhooks/static/decorated/ghec.json @@ -32463,7 +32463,7 @@ "installation": { "created": { "descriptionHtml": "Someone installed a GitHub App on a user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32680,7 +32680,7 @@ }, "deleted": { "descriptionHtml": "Someone uninstalled a GitHub App from their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32783,7 +32783,7 @@ }, "new_permissions_accepted": { "descriptionHtml": "Someone granted new permissions to a GitHub App.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32886,7 +32886,7 @@ }, "suspend": { "descriptionHtml": "Someone blocked access by a GitHub App to their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32989,7 +32989,7 @@ }, "unsuspend": { "descriptionHtml": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -33094,7 +33094,7 @@ "installation_repositories": { "added": { "descriptionHtml": "A GitHub App installation was granted access to one or more repositories.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -33358,7 +33358,7 @@ }, "removed": { "descriptionHtml": "Access to one or more repositories was revoked for a GitHub App installation.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -57202,7 +57202,7 @@ "merge_group": { "default": { "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", - "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in limited private beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -154909,7 +154909,7 @@ "category": "repository" }, "transferred": { - "descriptionHtml": "Ownership of the repository was transferred to a user or organization account.
", + "descriptionHtml": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { diff --git a/lib/webhooks/static/decorated/ghes-3.7.json b/lib/webhooks/static/decorated/ghes-3.7.json index b007c33c4727..1c7ced048e24 100644 --- a/lib/webhooks/static/decorated/ghes-3.7.json +++ b/lib/webhooks/static/decorated/ghes-3.7.json @@ -32243,7 +32243,7 @@ "installation": { "created": { "descriptionHtml": "Someone installed a GitHub App on a user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32460,7 +32460,7 @@ }, "deleted": { "descriptionHtml": "Someone uninstalled a GitHub App from their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32563,7 +32563,7 @@ }, "new_permissions_accepted": { "descriptionHtml": "Someone granted new permissions to a GitHub App.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32666,7 +32666,7 @@ }, "suspend": { "descriptionHtml": "Someone blocked access by a GitHub App to their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32769,7 +32769,7 @@ }, "unsuspend": { "descriptionHtml": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32874,7 +32874,7 @@ "installation_repositories": { "added": { "descriptionHtml": "A GitHub App installation was granted access to one or more repositories.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -33138,7 +33138,7 @@ }, "removed": { "descriptionHtml": "Access to one or more repositories was revoked for a GitHub App installation.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -56982,7 +56982,7 @@ "merge_group": { "default": { "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", - "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in limited private beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -154689,7 +154689,7 @@ "category": "repository" }, "transferred": { - "descriptionHtml": "Ownership of the repository was transferred to a user or organization account.
", + "descriptionHtml": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { diff --git a/lib/webhooks/static/decorated/ghes-3.8.json b/lib/webhooks/static/decorated/ghes-3.8.json new file mode 100644 index 000000000000..9bee18e5b078 --- /dev/null +++ b/lib/webhooks/static/decorated/ghes-3.8.json @@ -0,0 +1,169011 @@ +{ + "branch_protection_rule": { + "created": { + "descriptionHtml": "A branch protection rule was created.
", + "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "rule", + "in": "body", + "description": "The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "branch_protection_rule" + }, + "deleted": { + "descriptionHtml": "A branch protection rule was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "rule", + "in": "body", + "description": "The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "branch_protection_rule" + }, + "edited": { + "descriptionHtml": "A branch protection rule was edited.
", + "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "If the action was edited, the changes to the rule.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "rule", + "in": "body", + "description": "The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "branch_protection_rule" + } + }, + "check_run": { + "completed": { + "descriptionHtml": "A check run was completed, and a conclusion is available.
", + "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
A check performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "A suite of checks performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, + { + "type": "object", + "name": "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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "head_branch", + "description": "" + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the head commit that is being checked.
" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "Minimal Repository
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "Code Of Conduct
", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + }, + { + "type": "object or null", + "name": "security_and_analysis", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "advanced_security", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning_push_protection", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + } + ] + } + ] + }, + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ] + }, + { + "type": "object", + "name": "deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "details_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the commit that is being checked.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The id of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "output", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "annotations_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "annotations_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "text", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "The phase of the lifecycle that the check is currently in.
", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "completed", + "category": "check_run" + }, + "created": { + "descriptionHtml": "A new check run was created.
", + "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
A check performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "A suite of checks performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, + { + "type": "object", + "name": "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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "head_branch", + "description": "" + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the head commit that is being checked.
" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "Minimal Repository
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "Code Of Conduct
", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + }, + { + "type": "object or null", + "name": "security_and_analysis", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "advanced_security", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning_push_protection", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + } + ] + } + ] + }, + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ] + }, + { + "type": "object", + "name": "deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "details_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the commit that is being checked.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The id of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "output", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "annotations_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "annotations_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "text", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "The phase of the lifecycle that the check is currently in.
", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "check_run" + }, + "requested_action": { + "descriptionHtml": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
A check performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "A suite of checks performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, + { + "type": "object", + "name": "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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "head_branch", + "description": "" + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the head commit that is being checked.
" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "Minimal Repository
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "Code Of Conduct
", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + }, + { + "type": "object or null", + "name": "security_and_analysis", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "advanced_security", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning_push_protection", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + } + ] + } + ] + }, + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ] + }, + { + "type": "object", + "name": "deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "details_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the commit that is being checked.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The id of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "output", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "annotations_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "annotations_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "text", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "The phase of the lifecycle that the check is currently in.
", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "requested_action", + "in": "body", + "description": "The action requested by the user.
", + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The integrator reference of the action requested by the user.
" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "requested_action", + "category": "check_run" + }, + "rerequested": { + "descriptionHtml": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
A check performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "A suite of checks performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, + { + "type": "object", + "name": "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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "head_branch", + "description": "" + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the head commit that is being checked.
" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "Minimal Repository
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "" + }, + { + "type": "string or null", + "name": "homepage", + "description": "" + }, + { + "type": "string or null", + "name": "language", + "description": "" + }, + { + "type": "integer", + "name": "forks_count", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "" + }, + { + "type": "integer", + "name": "watchers_count", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
" + }, + { + "type": "string", + "name": "default_branch", + "description": "" + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "boolean", + "name": "has_issues", + "description": "" + }, + { + "type": "boolean", + "name": "has_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "" + }, + { + "type": "boolean", + "name": "has_pages", + "description": "" + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "" + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "" + }, + { + "type": "boolean", + "name": "disabled", + "description": "" + }, + { + "type": "string", + "name": "visibility", + "description": "" + }, + { + "type": "string or null", + "name": "pushed_at", + "description": "" + }, + { + "type": "string or null", + "name": "created_at", + "description": "" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "" + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "" + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "" + } + ] + }, + { + "type": "string", + "name": "role_name", + "description": "" + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "" + }, + { + "type": "integer", + "name": "subscribers_count", + "description": "" + }, + { + "type": "integer", + "name": "network_count", + "description": "" + }, + { + "type": "object", + "name": "code_of_conduct", + "description": "Code Of Conduct
", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "description": "" + }, + { + "type": "string or null", + "name": "html_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "license", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "spdx_id", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "forks", + "description": "" + }, + { + "type": "integer", + "name": "open_issues", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "" + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + }, + { + "type": "object or null", + "name": "security_and_analysis", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "advanced_security", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning_push_protection", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + } + ] + } + ] + }, + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ] + }, + { + "type": "object", + "name": "deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "details_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the commit that is being checked.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The id of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "output", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "annotations_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "annotations_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "text", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "title", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "The phase of the lifecycle that the check is currently in.
", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "rerequested", + "category": "check_run" + } + }, + "check_suite": { + "completed": { + "descriptionHtml": "All check runs in a check suite have completed, and a conclusion is available.
", + "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
The check_suite.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.
The head branch name the changes are on.
", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "object", + "name": "committer", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "string", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the head commit that is being checked.
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "latest_check_runs_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.
The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.
URL that points to the check suite API resource.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "completed", + "category": "check_suite" + }, + "requested": { + "descriptionHtml": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
The check_suite.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.
The head branch name the changes are on.
", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "object", + "name": "committer", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "string", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the head commit that is being checked.
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "latest_check_runs_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.
The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.
URL that points to the check suite API resource.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "requested", + "category": "check_suite" + }, + "rerequested": { + "descriptionHtml": "Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
The check_suite.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "before", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_runs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.
The head branch name the changes are on.
", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "object", + "name": "committer", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "string", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the head commit that is being checked.
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "latest_check_runs_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.
The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.
URL that points to the check suite API resource.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "rerequested", + "category": "check_suite" + } + }, + "code_scanning_alert": { + "appeared_in_branch": { + "descriptionHtml": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "appeared_in_branch" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "The code scanning alert involved in the event.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "The code scanning alert number.
", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "A short description of the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "id", + "description": "A unique identifier for the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "severity", + "description": "The severity of the alert.
", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + ] + }, + { + "type": "string", + "name": "state", + "description": "State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "The name of the tool used to generate the code scanning analysis alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "The version of the tool used to detect the alert.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "appeared_in_branch", + "category": "code_scanning_alert" + }, + "closed_by_user": { + "descriptionHtml": "Someone closed a code scanning alert.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "The code scanning alert involved in the event.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "The code scanning alert number.
", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "A short description of the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "A link to the documentation for the rule used to detect the alert.
" + }, + { + "type": "string", + "name": "id", + "description": "A unique identifier for the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "The severity of the alert.
", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "dismissed", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "The name of the tool used to generate the code scanning analysis alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "The version of the tool used to detect the alert.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "closed_by_user", + "category": "code_scanning_alert" + }, + "created": { + "descriptionHtml": "A code scanning alert was created in a repository.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "The code scanning alert involved in the event.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "The code scanning alert number.
", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "A short description of the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "A link to the documentation for the rule used to detect the alert.
" + }, + { + "type": "string", + "name": "id", + "description": "A unique identifier for the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "The severity of the alert.
", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed" + ] + }, + { + "type": "object or null", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "The name of the tool used to generate the code scanning analysis alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "The version of the tool used to detect the alert.
", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "code_scanning_alert" + }, + "fixed": { + "descriptionHtml": "A code scanning alert was fixed in a branch by a commit.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "fixed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "The code scanning alert involved in the event.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "The code scanning alert number.
", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "A short description of the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "A link to the documentation for the rule used to detect the alert.
" + }, + { + "type": "string", + "name": "id", + "description": "A unique identifier for the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "The severity of the alert.
", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "The name of the tool used to generate the code scanning analysis alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "The version of the tool used to detect the alert.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "fixed", + "category": "code_scanning_alert" + }, + "reopened": { + "descriptionHtml": "A previously fixed code scanning alert reappeared in a branch.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "alert", + "in": "body", + "description": "The code scanning alert involved in the event.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "The code scanning alert number.
", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "A short description of the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "full_description", + "description": "" + }, + { + "type": "string or null", + "name": "help", + "description": "" + }, + { + "type": "string or null", + "name": "help_uri", + "description": "A link to the documentation for the rule used to detect the alert.
" + }, + { + "type": "string", + "name": "id", + "description": "A unique identifier for the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "severity", + "description": "The severity of the alert.
", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + { + "type": "array of strings or null", + "name": "tags", + "description": "" + } + ] + }, + { + "type": "string", + "name": "state", + "description": "State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "guid", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "The name of the tool used to generate the code scanning analysis alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "The version of the tool used to detect the alert.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "commit_oid", + "in": "body", + "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string or null", + "name": "ref", + "in": "body", + "description": "The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "code_scanning_alert" + }, + "reopened_by_user": { + "descriptionHtml": "Someone reopened a code scanning alert.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "The code scanning alert involved in the event.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "The code scanning alert number.
", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "A short description of the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "id", + "description": "A unique identifier for the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "severity", + "description": "The severity of the alert.
", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + ] + }, + { + "type": "string", + "name": "state", + "description": "State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "fixed" + ] + }, + { + "type": "object", + "name": "tool", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "The name of the tool used to generate the code scanning analysis alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "The version of the tool used to detect the alert.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "commit_oid", + "in": "body", + "description": "The commit SHA of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "The Git reference of the code scanning alert. When the action is reopened_by_user or closed_by_user, the event was triggered by the sender and this value will be empty.
A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened_by_user", + "category": "code_scanning_alert" + } + }, + "commit_comment": { + "created": { + "descriptionHtml": "Someone commented on a commit.
", + "summaryHtml": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.
\nFor activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "The action performed. Can be created.
The commit comment resource.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "The text of the comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "The SHA of the commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The ID of the commit comment.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node ID of the commit comment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "path", + "description": "The relative path of the file to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "The line index in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "commit_comment" + } + }, + "create": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a Git branch or tag is created.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\nNote: This event will not occur when more than three tags are created at once.
", + "bodyParameters": [ + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "The repository's current description.
", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "master_branch", + "in": "body", + "description": "The name of the repository's default branch (usually main).
A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "The pusher type for the event. Can be either user or a deploy key.
The git ref resource.
The type of Git ref object created in the repository.
", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "create" + } + }, + "delete": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a Git branch or tag is deleted.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\nNote: This event will not occur when more than three tags are deleted at once.
", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "pusher_type", + "in": "body", + "description": "The pusher type for the event. Can be either user or a deploy key.
The git ref resource.
The type of Git ref object deleted in the repository.
", + "isRequired": true, + "enum": [ + "tag", + "branch" + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "delete" + } + }, + "dependabot_alert": { + "created": { + "descriptionHtml": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "A Dependabot alert.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the Dependabot alert.
", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "Details for the vulnerable dependency.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "The full path to the dependency manifest file, relative to the root of the repository.
" + }, + { + "type": "string or null", + "name": "scope", + "description": "The execution scope of the vulnerable dependency.
", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "Details for the GitHub Security Advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "The unique CVE ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "A short, plain text summary of the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "A long-form Markdown-supported description of the advisory.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "Vulnerable version range information for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the advisory.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "The overall CVSS score of the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "The full CVSS vector string for the advisory.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "The unique CWE ID.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The short, plain text name of the CWE.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "Values that identify this advisory among security information sources.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of advisory identifier.
", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "The value of the advisory identifer.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "Links to additional advisory information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "The URL of the reference.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "url", + "description": "The REST API URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "The reason that the alert was dismissed.
", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "An optional comment associated with the alert's dismissal.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "dependabot_alert" + }, + "dismissed": { + "descriptionHtml": "A Dependabot alert was manually closed.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "dismissed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "A Dependabot alert.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the Dependabot alert.
", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "Details for the vulnerable dependency.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "The full path to the dependency manifest file, relative to the root of the repository.
" + }, + { + "type": "string or null", + "name": "scope", + "description": "The execution scope of the vulnerable dependency.
", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "Details for the GitHub Security Advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "The unique CVE ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "A short, plain text summary of the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "A long-form Markdown-supported description of the advisory.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "Vulnerable version range information for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the advisory.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "The overall CVSS score of the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "The full CVSS vector string for the advisory.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "The unique CWE ID.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The short, plain text name of the CWE.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "Values that identify this advisory among security information sources.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of advisory identifier.
", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "The value of the advisory identifer.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "Links to additional advisory information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "The URL of the reference.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "url", + "description": "The REST API URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "The reason that the alert was dismissed.
", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "An optional comment associated with the alert's dismissal.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "dismissed", + "category": "dependabot_alert" + }, + "fixed": { + "descriptionHtml": "A manifest file change removed a vulnerability.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "fixed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "A Dependabot alert.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the Dependabot alert.
", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "Details for the vulnerable dependency.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "The full path to the dependency manifest file, relative to the root of the repository.
" + }, + { + "type": "string or null", + "name": "scope", + "description": "The execution scope of the vulnerable dependency.
", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "Details for the GitHub Security Advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "The unique CVE ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "A short, plain text summary of the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "A long-form Markdown-supported description of the advisory.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "Vulnerable version range information for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the advisory.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "The overall CVSS score of the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "The full CVSS vector string for the advisory.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "The unique CWE ID.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The short, plain text name of the CWE.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "Values that identify this advisory among security information sources.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of advisory identifier.
", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "The value of the advisory identifer.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "Links to additional advisory information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "The URL of the reference.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "url", + "description": "The REST API URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "The reason that the alert was dismissed.
", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "An optional comment associated with the alert's dismissal.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "fixed", + "category": "dependabot_alert" + }, + "reintroduced": { + "descriptionHtml": "A manifest file change introduced a vulnerable dependency that had previously been fixed.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reintroduced" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "A Dependabot alert.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the Dependabot alert.
", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "Details for the vulnerable dependency.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "The full path to the dependency manifest file, relative to the root of the repository.
" + }, + { + "type": "string or null", + "name": "scope", + "description": "The execution scope of the vulnerable dependency.
", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "Details for the GitHub Security Advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "The unique CVE ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "A short, plain text summary of the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "A long-form Markdown-supported description of the advisory.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "Vulnerable version range information for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the advisory.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "The overall CVSS score of the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "The full CVSS vector string for the advisory.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "The unique CWE ID.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The short, plain text name of the CWE.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "Values that identify this advisory among security information sources.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of advisory identifier.
", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "The value of the advisory identifer.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "Links to additional advisory information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "The URL of the reference.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "url", + "description": "The REST API URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "The reason that the alert was dismissed.
", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "An optional comment associated with the alert's dismissal.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reintroduced", + "category": "dependabot_alert" + }, + "reopened": { + "descriptionHtml": "A Dependabot alert was manually reopened.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "A Dependabot alert.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the Dependabot alert.
", + "isRequired": true, + "enum": [ + "dismissed", + "fixed", + "open" + ] + }, + { + "type": "object", + "name": "dependency", + "description": "Details for the vulnerable dependency.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "manifest_path", + "description": "The full path to the dependency manifest file, relative to the root of the repository.
" + }, + { + "type": "string or null", + "name": "scope", + "description": "The execution scope of the vulnerable dependency.
", + "enum": [ + "development", + "runtime", + null + ] + } + ] + }, + { + "type": "object", + "name": "security_advisory", + "description": "Details for the GitHub Security Advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ghsa_id", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "cve_id", + "description": "The unique CVE ID assigned to the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "A short, plain text summary of the advisory.
", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "A long-form Markdown-supported description of the advisory.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "Vulnerable version range information for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the advisory.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "object", + "name": "cvss", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "The overall CVSS score of the advisory.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "The full CVSS vector string for the advisory.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "The unique CWE ID.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The short, plain text name of the CWE.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "Values that identify this advisory among security information sources.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of advisory identifier.
", + "isRequired": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + { + "type": "string", + "name": "value", + "description": "The value of the advisory identifer.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "references", + "description": "Links to additional advisory information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "The URL of the reference.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "The time that the advisory was published in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was last modified in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the advisory was withdrawn in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Details pertaining to one vulnerable version range for the advisory.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "package", + "description": "Details for the vulnerable package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "The package's language or package management ecosystem.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The unique package name within its ecosystem.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "The severity of the vulnerability.
", + "isRequired": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "first_patched_version", + "description": "Details pertaining to the package version that patches this vulnerability.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "The package version that patches this vulnerability.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "url", + "description": "The REST API URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "dismissed_reason", + "description": "The reason that the alert was dismissed.
", + "isRequired": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + { + "type": "string or null", + "name": "dismissed_comment", + "description": "An optional comment associated with the alert's dismissal.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "fixed_at", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "dependabot_alert" + } + }, + "deploy_key": { + "created": { + "descriptionHtml": "A deploy key was created.
", + "summaryHtml": "This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "The deploy key resource.
A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "deploy_key" + }, + "deleted": { + "descriptionHtml": "A deploy key was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL documentation or \"Deploy keys\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "key", + "in": "body", + "description": "The deploy key resource.
A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "deploy_key" + } + }, + "deployment": { + "created": { + "descriptionHtml": "A deployment was created.
", + "summaryHtml": "This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment status, use the deployment_status event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "The deployment.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "environment", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "production_environment", + "description": "" + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "workflow", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "badge_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "workflow_run", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object or null", + "name": "actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "artifacts_url", + "description": "" + }, + { + "type": "string", + "name": "cancel_url", + "description": "" + }, + { + "type": "integer", + "name": "check_suite_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_suite_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_suite_url", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "display_title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "event", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "head_branch", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "head_commit", + "description": "" + }, + { + "type": "object", + "name": "head_repository", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "" + }, + { + "type": "string", + "name": "assignees_url", + "description": "" + }, + { + "type": "string", + "name": "blobs_url", + "description": "" + }, + { + "type": "string", + "name": "branches_url", + "description": "" + }, + { + "type": "string", + "name": "collaborators_url", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "" + }, + { + "type": "string", + "name": "compare_url", + "description": "" + }, + { + "type": "string", + "name": "contents_url", + "description": "" + }, + { + "type": "string", + "name": "contributors_url", + "description": "" + }, + { + "type": "string", + "name": "deployments_url", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "downloads_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "boolean", + "name": "fork", + "description": "" + }, + { + "type": "string", + "name": "forks_url", + "description": "" + }, + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "string", + "name": "git_commits_url", + "description": "" + }, + { + "type": "string", + "name": "git_refs_url", + "description": "" + }, + { + "type": "string", + "name": "git_tags_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "" + }, + { + "type": "string", + "name": "issue_events_url", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "keys_url", + "description": "" + }, + { + "type": "string", + "name": "labels_url", + "description": "" + }, + { + "type": "string", + "name": "languages_url", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "" + }, + { + "type": "string", + "name": "milestones_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "notifications_url", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "jobs_url", + "description": "" + }, + { + "type": "string", + "name": "logs_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "previous_attempt_url", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects or null", + "name": "referenced_workflows", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "" + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "" + }, + { + "type": "string", + "name": "assignees_url", + "description": "" + }, + { + "type": "string", + "name": "blobs_url", + "description": "" + }, + { + "type": "string", + "name": "branches_url", + "description": "" + }, + { + "type": "string", + "name": "collaborators_url", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "" + }, + { + "type": "string", + "name": "compare_url", + "description": "" + }, + { + "type": "string", + "name": "contents_url", + "description": "" + }, + { + "type": "string", + "name": "contributors_url", + "description": "" + }, + { + "type": "string", + "name": "deployments_url", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "downloads_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "boolean", + "name": "fork", + "description": "" + }, + { + "type": "string", + "name": "forks_url", + "description": "" + }, + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "string", + "name": "git_commits_url", + "description": "" + }, + { + "type": "string", + "name": "git_refs_url", + "description": "" + }, + { + "type": "string", + "name": "git_tags_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "" + }, + { + "type": "string", + "name": "issue_events_url", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "keys_url", + "description": "" + }, + { + "type": "string", + "name": "labels_url", + "description": "" + }, + { + "type": "string", + "name": "languages_url", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "" + }, + { + "type": "string", + "name": "milestones_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "notifications_url", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "rerun_url", + "description": "" + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + { + "type": "object or null", + "name": "triggering_actor", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "workflow_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "workflow_url", + "description": "" + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "deployment" + } + }, + "deployment_status": { + "created": { + "descriptionHtml": "A new deployment status was created.
", + "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "check_run", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.
The SHA of the commit that is being checked.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The id of the check.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the check run.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "The current status of the check run. Can be queued, in_progress, or completed.
The deployment.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "environment", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "", + "isRequired": true + }, + { + "type": "null or string or object", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "production_environment", + "description": "" + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "deployment_status", + "in": "body", + "description": "The deployment status.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "deployment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "The optional human-readable description added to the status.
", + "isRequired": true + }, + { + "type": "string", + "name": "environment", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "environment_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "log_url", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The new state. Can be pending, success, failure, or error.
The optional link added to the status.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "workflow", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "badge_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "workflow_run", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object or null", + "name": "actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "artifacts_url", + "description": "" + }, + { + "type": "string", + "name": "cancel_url", + "description": "" + }, + { + "type": "integer", + "name": "check_suite_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_suite_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_suite_url", + "description": "" + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "startup_failure" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "display_title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "event", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "head_branch", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "head_commit", + "description": "" + }, + { + "type": "object", + "name": "head_repository", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "" + }, + { + "type": "string", + "name": "assignees_url", + "description": "" + }, + { + "type": "string", + "name": "blobs_url", + "description": "" + }, + { + "type": "string", + "name": "branches_url", + "description": "" + }, + { + "type": "string", + "name": "collaborators_url", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "" + }, + { + "type": "string", + "name": "compare_url", + "description": "" + }, + { + "type": "string", + "name": "contents_url", + "description": "" + }, + { + "type": "string", + "name": "contributors_url", + "description": "" + }, + { + "type": "string", + "name": "deployments_url", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "downloads_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "boolean", + "name": "fork", + "description": "" + }, + { + "type": "string", + "name": "forks_url", + "description": "" + }, + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "string", + "name": "git_commits_url", + "description": "" + }, + { + "type": "string", + "name": "git_refs_url", + "description": "" + }, + { + "type": "string", + "name": "git_tags_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "" + }, + { + "type": "string", + "name": "issue_events_url", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "keys_url", + "description": "" + }, + { + "type": "string", + "name": "labels_url", + "description": "" + }, + { + "type": "string", + "name": "languages_url", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "" + }, + { + "type": "string", + "name": "milestones_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "notifications_url", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "jobs_url", + "description": "" + }, + { + "type": "string", + "name": "logs_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "previous_attempt_url", + "description": "" + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects or null", + "name": "referenced_workflows", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "" + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "" + }, + { + "type": "string", + "name": "assignees_url", + "description": "" + }, + { + "type": "string", + "name": "blobs_url", + "description": "" + }, + { + "type": "string", + "name": "branches_url", + "description": "" + }, + { + "type": "string", + "name": "collaborators_url", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "" + }, + { + "type": "string", + "name": "compare_url", + "description": "" + }, + { + "type": "string", + "name": "contents_url", + "description": "" + }, + { + "type": "string", + "name": "contributors_url", + "description": "" + }, + { + "type": "string", + "name": "deployments_url", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "downloads_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "boolean", + "name": "fork", + "description": "" + }, + { + "type": "string", + "name": "forks_url", + "description": "" + }, + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "string", + "name": "git_commits_url", + "description": "" + }, + { + "type": "string", + "name": "git_refs_url", + "description": "" + }, + { + "type": "string", + "name": "git_tags_url", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "" + }, + { + "type": "string", + "name": "issue_events_url", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "keys_url", + "description": "" + }, + { + "type": "string", + "name": "labels_url", + "description": "" + }, + { + "type": "string", + "name": "languages_url", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "" + }, + { + "type": "string", + "name": "milestones_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "notifications_url", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "" + }, + { + "type": "string", + "name": "releases_url", + "description": "" + }, + { + "type": "string", + "name": "stargazers_url", + "description": "" + }, + { + "type": "string", + "name": "statuses_url", + "description": "" + }, + { + "type": "string", + "name": "subscribers_url", + "description": "" + }, + { + "type": "string", + "name": "subscription_url", + "description": "" + }, + { + "type": "string", + "name": "tags_url", + "description": "" + }, + { + "type": "string", + "name": "teams_url", + "description": "" + }, + { + "type": "string", + "name": "trees_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "rerun_url", + "description": "" + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + { + "type": "object or null", + "name": "triggering_actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "workflow_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "workflow_url", + "description": "" + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "deployment_status" + } + }, + "discussion": { + "answered": { + "descriptionHtml": "A comment on the discussion was marked as the answer.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "answered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "answer", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "answered", + "category": "discussion" + }, + "category_changed": { + "descriptionHtml": "The category of a discussion was changed.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "category_changed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "category_changed", + "category": "discussion" + }, + "created": { + "descriptionHtml": "A discussion was created.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "discussion" + }, + "deleted": { + "descriptionHtml": "A discussion was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "discussion" + }, + "edited": { + "descriptionHtml": "The title or body on a discussion was edited, or the category of the discussion was changed.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "title", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "discussion" + }, + "labeled": { + "descriptionHtml": "A label was added to a discussion.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "labeled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "labeled", + "category": "discussion" + }, + "locked": { + "descriptionHtml": "A discussion was locked.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "locked" + ], + "childParamsGroups": [] + }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "locked", + "category": "discussion" + }, + "pinned": { + "descriptionHtml": "A discussion was pinned.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "pinned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "pinned", + "category": "discussion" + }, + "transferred": { + "descriptionHtml": "A discussion was transferred to another repository.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "transferred" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "new_discussion", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "new_repository", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "transferred", + "category": "discussion" + }, + "unanswered": { + "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unanswered" + ], + "childParamsGroups": [] + }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "old_answer", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unanswered", + "category": "discussion" + }, + "unlabeled": { + "descriptionHtml": "A label was removed from a discussion.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlabeled", + "category": "discussion" + }, + "unlocked": { + "descriptionHtml": "A discussion was unlocked.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlocked" + ], + "childParamsGroups": [] + }, + { + "type": "", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlocked", + "category": "discussion" + }, + "unpinned": { + "descriptionHtml": "A discussion was unpinned.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unpinned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unpinned", + "category": "discussion" + } + }, + "discussion_comment": { + "created": { + "descriptionHtml": "A comment on a discussion was created.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "discussion_comment" + }, + "deleted": { + "descriptionHtml": "A comment on a discussion was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "discussion_comment" + }, + "edited": { + "descriptionHtml": "A comment on a discussion was edited.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "discussion", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "locked", + "converting", + "transferring" + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "discussion_comment" + } + }, + "fork": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "forkee", + "in": "body", + "description": "The created repository resource.
The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "default", + "category": "fork" + } + }, + "github_app_authorization": { + "revoked": { + "descriptionHtml": "Someone revoked their authorization of a GitHub App.
", + "summaryHtml": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.
\nAnyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about user-to-server requests, which require GitHub App authorization, see \"Identifying and authorizing users for GitHub Apps.\"
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "revoked", + "category": "github_app_authorization" + } + }, + "gollum": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "pages", + "in": "body", + "description": "The pages that were updated.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "action", + "description": "The action that was performed on the page. Can be created or edited.
Points to the HTML wiki page.
", + "isRequired": true + }, + { + "type": "string", + "name": "page_name", + "description": "The name of the page.
", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "The latest commit SHA of the page.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "The current page title.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "gollum" + } + }, + "installation": { + "created": { + "descriptionHtml": "Someone installed a GitHub App on a user or organization account.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "Installation
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "An array of repository objects that the installation can access.
", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requester", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "created", + "category": "installation" + }, + "deleted": { + "descriptionHtml": "Someone uninstalled a GitHub App from their user or organization account.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "Installation
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "An array of repository objects that the installation can access.
", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "deleted", + "category": "installation" + }, + "new_permissions_accepted": { + "descriptionHtml": "Someone granted new permissions to a GitHub App.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "new_permissions_accepted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "Installation
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "An array of repository objects that the installation can access.
", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "new_permissions_accepted", + "category": "installation" + }, + "suspend": { + "descriptionHtml": "Someone blocked access by a GitHub App to their user or organization account.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "suspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "Installation
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "An array of repository objects that the installation can access.
", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "suspend", + "category": "installation" + }, + "unsuspend": { + "descriptionHtml": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unsuspend" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "Installation
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories", + "in": "body", + "description": "An array of repository objects that the installation can access.
", + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "null", + "name": "requester", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "unsuspend", + "category": "installation" + } + }, + "installation_repositories": { + "added": { + "descriptionHtml": "A GitHub App installation was granted access to one or more repositories.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "added" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "Installation
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "An array of repository objects, which were added to the installation.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "An array of repository objects, which were removed from the installation.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
" + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
" + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "repository_selection", + "in": "body", + "description": "Describe whether all repositories have been selected or there's a selection involved
", + "isRequired": true, + "enum": [ + "all", + "selected" + ] + }, + { + "type": "object or null", + "name": "requester", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "added", + "category": "installation_repositories" + }, + "removed": { + "descriptionHtml": "Access to one or more repositories was revoked for a GitHub App installation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "Installation
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "name": "repositories_added", + "in": "body", + "description": "An array of repository objects, which were added to the installation.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "repositories_removed", + "in": "body", + "description": "An array of repository objects, which were removed from the installation.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "repository_selection", + "in": "body", + "description": "Describe whether all repositories have been selected or there's a selection involved
", + "isRequired": true, + "enum": [ + "all", + "selected" + ] + }, + { + "type": "object or null", + "name": "requester", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "removed", + "category": "installation_repositories" + } + }, + "installation_target": { + "default": { + "descriptionHtml": "Somebody renamed the user or organization account that a GitHub App is installed on.
", + "summaryHtml": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "object", + "name": "account", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "null", + "name": "description", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "integer", + "name": "followers", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "integer", + "name": "following", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "boolean", + "name": "has_organization_projects", + "description": "" + }, + { + "type": "boolean", + "name": "has_repository_projects", + "description": "" + }, + { + "type": "string", + "name": "hooks_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_verified", + "description": "" + }, + { + "type": "string", + "name": "issues_url", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "integer", + "name": "public_gists", + "description": "" + }, + { + "type": "string", + "name": "public_members_url", + "description": "" + }, + { + "type": "integer", + "name": "public_repos", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "null", + "name": "website_url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "login", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "slug", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "target_type", + "in": "body", + "description": "", + "isRequired": true + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "installation_target" + } + }, + "issue_comment": { + "created": { + "descriptionHtml": "A comment on an issue or pull request was created.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "The comment itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "Contents of the issue comment
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the issue comment
", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "performed_via_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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue comment
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "The issue the comment belongs to.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "issue_comment" + }, + "deleted": { + "descriptionHtml": "A comment on an issue or pull request was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "The comment itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "Contents of the issue comment
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the issue comment
", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "performed_via_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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue comment
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "The issue the comment belongs to.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "issue_comment" + }, + "edited": { + "descriptionHtml": "A comment on an issue or pull request was edited.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the comment.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the body.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "The comment itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "Contents of the issue comment
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the issue comment
", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "performed_via_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.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue comment
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "The issue the comment belongs to.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "issue_comment" + } + }, + "issues": { + "assigned": { + "descriptionHtml": "An issue was assigned to a user.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "The action that was performed.
", + "isRequired": true, + "enum": [ + "assigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "assigned", + "category": "issues" + }, + "closed": { + "descriptionHtml": "An issue was closed.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "The action that was performed.
", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "closed", + "category": "issues" + }, + "deleted": { + "descriptionHtml": "An issue was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "issues" + }, + "demilestoned": { + "descriptionHtml": "An issue was removed from a milestone.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "demilestoned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "demilestoned", + "category": "issues" + }, + "edited": { + "descriptionHtml": "The title or body on an issue was edited.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the issue.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the body.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "title", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the title.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "issues" + }, + "labeled": { + "descriptionHtml": "A label was added to an issue.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "labeled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "labeled", + "category": "issues" + }, + "locked": { + "descriptionHtml": "Conversation on an issue was locked. For more information, see \"Locking conversations.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "locked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "locked", + "category": "issues" + }, + "milestoned": { + "descriptionHtml": "An issue was added to a milestone.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "milestoned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "milestoned", + "category": "issues" + }, + "opened": { + "descriptionHtml": "An issue was created. When a closed issue is reopened, the action will be reopened instead.
This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "opened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object or null", + "name": "old_issue", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "old_repository", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "opened", + "category": "issues" + }, + "pinned": { + "descriptionHtml": "An issue was pinned to a repository. For more information, see \"Pinning an issue to your repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "pinned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "pinned", + "category": "issues" + }, + "reopened": { + "descriptionHtml": "A closed issue was reopened.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "issues" + }, + "transferred": { + "descriptionHtml": "An issue was transferred to another repository. For more information, see \"Transferring an issue to another repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "transferred" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "new_issue", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "new_repository", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "transferred", + "category": "issues" + }, + "unassigned": { + "descriptionHtml": "A user was unassigned from an issue.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "The action that was performed.
", + "isRequired": true, + "enum": [ + "unassigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unassigned", + "category": "issues" + }, + "unlabeled": { + "descriptionHtml": "A label was removed from an issue.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlabeled", + "category": "issues" + }, + "unlocked": { + "descriptionHtml": "Conversation on an issue was locked. For more information, see \"Locking conversations.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlocked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "issue", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlocked", + "category": "issues" + }, + "unpinned": { + "descriptionHtml": "An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unpinned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "The issue itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "Contents of the issue
", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the issue; either 'open' or 'closed'
", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "Title of the issue
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the issue
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unpinned", + "category": "issues" + } + }, + "label": { + "created": { + "descriptionHtml": "A label was created.
", + "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "label" + }, + "deleted": { + "descriptionHtml": "A label was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "label" + }, + "edited": { + "descriptionHtml": "A label's name, description, or color was changed.
", + "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the label if the action was edited.
The previous version of the color if the action was edited.
The previous version of the description if the action was edited.
The previous version of the name if the action was edited.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "label" + } + }, + "marketplace_purchase": { + "cancelled": { + "descriptionHtml": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "cancelled" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "effective_date", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "marketplace_purchase", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "previous_marketplace_purchase", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "account", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "organization_billing_email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "billing_cycle", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "free_trial_ends_on", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "next_billing_date", + "description": "" + }, + { + "type": "boolean", + "name": "on_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "plan", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "bullets", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "monthly_price_in_cents", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "price_model", + "description": "", + "isRequired": true, + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + { + "type": "string or null", + "name": "unit_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "yearly_price_in_cents", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "unit_count", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "marketplace" + ], + "action": "cancelled", + "category": "marketplace_purchase" + }, + "changed": { + "descriptionHtml": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "changed" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "effective_date", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "marketplace_purchase", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "previous_marketplace_purchase", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "account", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "organization_billing_email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "billing_cycle", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "free_trial_ends_on", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "next_billing_date", + "description": "" + }, + { + "type": "boolean or null", + "name": "on_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "plan", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "bullets", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "monthly_price_in_cents", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "price_model", + "description": "", + "isRequired": true, + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + { + "type": "string or null", + "name": "unit_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "yearly_price_in_cents", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "unit_count", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "marketplace" + ], + "action": "changed", + "category": "marketplace_purchase" + }, + "pending_change": { + "descriptionHtml": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the changed or cancelled event will be sent.
This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "pending_change" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "effective_date", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "marketplace_purchase", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "previous_marketplace_purchase", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "account", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "organization_billing_email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "billing_cycle", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "free_trial_ends_on", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "next_billing_date", + "description": "" + }, + { + "type": "boolean", + "name": "on_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "plan", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "bullets", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "monthly_price_in_cents", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "price_model", + "description": "", + "isRequired": true, + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + { + "type": "string or null", + "name": "unit_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "yearly_price_in_cents", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "unit_count", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "marketplace" + ], + "action": "pending_change", + "category": "marketplace_purchase" + }, + "pending_change_cancelled": { + "descriptionHtml": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "pending_change_cancelled" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "effective_date", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "marketplace_purchase", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "previous_marketplace_purchase", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "account", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "organization_billing_email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "billing_cycle", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "free_trial_ends_on", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "next_billing_date", + "description": "" + }, + { + "type": "boolean", + "name": "on_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "plan", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "bullets", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "monthly_price_in_cents", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "price_model", + "description": "", + "isRequired": true, + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + { + "type": "string or null", + "name": "unit_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "yearly_price_in_cents", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "unit_count", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "marketplace" + ], + "action": "pending_change_cancelled", + "category": "marketplace_purchase" + }, + "purchased": { + "descriptionHtml": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "purchased" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "effective_date", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "marketplace_purchase", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "previous_marketplace_purchase", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "account", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "organization_billing_email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "billing_cycle", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "free_trial_ends_on", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "next_billing_date", + "description": "" + }, + { + "type": "boolean", + "name": "on_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "plan", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "bullets", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_free_trial", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "monthly_price_in_cents", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "price_model", + "description": "", + "isRequired": true, + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + { + "type": "string or null", + "name": "unit_name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "yearly_price_in_cents", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "unit_count", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "marketplace" + ], + "action": "purchased", + "category": "marketplace_purchase" + } + }, + "member": { + "added": { + "descriptionHtml": "A GitHub user accepted an invitation to a repository.
", + "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "added" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "permission", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "to", + "description": "", + "isRequired": true, + "enum": [ + "write", + "admin", + "read" + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "member", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "added", + "category": "member" + }, + "edited": { + "descriptionHtml": "Permissions were changed for a collaborator on a repository.
", + "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the collaborator permissions
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "old_permission", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous permissions of the collaborator if the action was edited.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "permission", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "member", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "member" + }, + "removed": { + "descriptionHtml": "A collaborator was removed from a repository.
", + "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "member", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "removed", + "category": "member" + } + }, + "membership": { + "added": { + "descriptionHtml": "An organization member was added to a team.
", + "summaryHtml": "This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "added" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "member", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "scope", + "in": "body", + "description": "The scope of the membership. Currently, can only be team.
Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "added", + "category": "membership" + }, + "removed": { + "descriptionHtml": "An organization member was removed from a team.
", + "summaryHtml": "This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the API to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "member", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "scope", + "in": "body", + "description": "The scope of the membership. Currently, can only be team.
Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "removed", + "category": "membership" + } + }, + "merge_group": { + "default": { + "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", + "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "merge_group", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "head_sha", + "description": "The SHA of the merge group.
", + "isRequired": true + }, + { + "type": "string", + "name": "head_ref", + "description": "The full ref of the merge group.
", + "isRequired": true + }, + { + "type": "string", + "name": "base_sha", + "description": "The SHA of the merge group's parent commit.
", + "isRequired": true + }, + { + "type": "string", + "name": "base_ref", + "description": "The full ref of the branch the merge group will be merged into.
", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "object", + "name": "committer", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "string", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "merge_group" + } + }, + "meta": { + "deleted": { + "descriptionHtml": "The webhook was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a webhook itself.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "hook", + "in": "body", + "description": "The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "active", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "config", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "content_type", + "description": "", + "isRequired": true, + "enum": [ + "json", + "form" + ] + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "secret", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "hook_id", + "in": "body", + "description": "The id of the modified webhook.
", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "marketplace", + "business", + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "meta" + } + }, + "milestone": { + "closed": { + "descriptionHtml": "A milestone was closed.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "closed", + "category": "milestone" + }, + "created": { + "descriptionHtml": "A milestone was created.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "milestone" + }, + "deleted": { + "descriptionHtml": "A milestone was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "milestone" + }, + "edited": { + "descriptionHtml": "A milestone was edited.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the milestone if the action was edited.
The previous version of the description if the action was edited.
The previous version of the due date if the action was edited.
The previous version of the title if the action was edited.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "milestone" + }, + "opened": { + "descriptionHtml": "A milestone was opened.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "opened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "opened", + "category": "milestone" + } + }, + "org_block": { + "blocked": { + "descriptionHtml": "A user was blocked from the organization.
", + "summaryHtml": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"Blocking a user from your organization.\" For information about the APIs to manage blocked users, see the GraphQL documentation or \"Blocking users\" in the REST API documentation.
\nIf you want to receive an event when members are added or removed from an organization, use the organization event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "blocked" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "blocked_user", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "blocked", + "category": "org_block" + }, + "unblocked": { + "descriptionHtml": "A previously blocked user was unblocked from the organization.
", + "summaryHtml": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"Blocking a user from your organization.\" For information about the APIs to manage blocked users, see the GraphQL documentation or \"Blocking users\" in the REST API documentation.
\nIf you want to receive an event when members are added or removed from an organization, use the organization event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unblocked" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "blocked_user", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "unblocked", + "category": "org_block" + } + }, + "organization": { + "deleted": { + "descriptionHtml": "An organization was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "membership", + "in": "body", + "description": "The membership between the user and the organization. Not present when the action is member_invited.
A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "deleted", + "category": "organization" + }, + "member_added": { + "descriptionHtml": "A member accepted an invitation to join an organization.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "member_added" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "membership", + "in": "body", + "description": "The membership between the user and the organization. Not present when the action is member_invited.
A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "member_added", + "category": "organization" + }, + "member_invited": { + "descriptionHtml": "A member was invited to join the organization.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "member_invited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "invitation", + "in": "body", + "description": "The invitation for the user or email if the action is member_invited.
A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "user", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "member_invited", + "category": "organization" + }, + "member_removed": { + "descriptionHtml": "A member was removed from the organization.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "member_removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "membership", + "in": "body", + "description": "The membership between the user and the organization. Not present when the action is member_invited.
A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "member_removed", + "category": "organization" + }, + "renamed": { + "descriptionHtml": "The name of an organization was changed.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "renamed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "login", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "membership", + "in": "body", + "description": "The membership between the user and the organization. Not present when the action is member_invited.
A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "renamed", + "category": "organization" + } + }, + "package": { + "published": { + "descriptionHtml": "A package was published to a registry.
", + "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "published" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "package", + "in": "body", + "description": "Information about the package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ecosystem", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "namespace", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "package_type", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "package_version", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object or null", + "name": "author", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or object", + "name": "body", + "description": "" + }, + { + "type": "string", + "name": "body_html", + "description": "" + }, + { + "type": "object or null", + "name": "container_metadata", + "description": "", + "childParamsGroups": [ + { + "type": "object or null", + "name": "labels", + "description": "" + }, + { + "type": "object or null", + "name": "manifest", + "description": "" + }, + { + "type": "object", + "name": "tag", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "digest", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "docker_metadata", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "installation_command", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "manifest", + "description": "" + }, + { + "type": "array of objects", + "name": "metadata", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "npm_metadata", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "version", + "description": "" + }, + { + "type": "string", + "name": "npm_user", + "description": "" + }, + { + "type": "object or null", + "name": "author", + "description": "" + }, + { + "type": "object or null", + "name": "bugs", + "description": "" + }, + { + "type": "object", + "name": "dependencies", + "description": "" + }, + { + "type": "object", + "name": "dev_dependencies", + "description": "" + }, + { + "type": "object", + "name": "peer_dependencies", + "description": "" + }, + { + "type": "object", + "name": "optional_dependencies", + "description": "" + }, + { + "type": "string", + "name": "description", + "description": "" + }, + { + "type": "object or null", + "name": "dist", + "description": "" + }, + { + "type": "string", + "name": "git_head", + "description": "" + }, + { + "type": "string", + "name": "homepage", + "description": "" + }, + { + "type": "string", + "name": "license", + "description": "" + }, + { + "type": "string", + "name": "main", + "description": "" + }, + { + "type": "object or null", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "scripts", + "description": "" + }, + { + "type": "string", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_version", + "description": "" + }, + { + "type": "string", + "name": "npm_version", + "description": "" + }, + { + "type": "boolean", + "name": "has_shrinkwrap", + "description": "" + }, + { + "type": "array of objects", + "name": "maintainers", + "description": "" + }, + { + "type": "array of objects", + "name": "contributors", + "description": "" + }, + { + "type": "object", + "name": "engines", + "description": "" + }, + { + "type": "array of strings", + "name": "keywords", + "description": "" + }, + { + "type": "array of strings", + "name": "files", + "description": "" + }, + { + "type": "object", + "name": "bin", + "description": "" + }, + { + "type": "object", + "name": "man", + "description": "" + }, + { + "type": "object or null", + "name": "directories", + "description": "" + }, + { + "type": "array of strings", + "name": "os", + "description": "" + }, + { + "type": "array of strings", + "name": "cpu", + "description": "" + }, + { + "type": "string", + "name": "readme", + "description": "" + }, + { + "type": "string", + "name": "installation_command", + "description": "" + }, + { + "type": "integer", + "name": "release_id", + "description": "" + }, + { + "type": "string", + "name": "commit_oid", + "description": "" + }, + { + "type": "boolean", + "name": "published_via_actions", + "description": "" + }, + { + "type": "integer", + "name": "deleted_by_id", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "nuget_metadata", + "description": "", + "childParamsGroups": [ + { + "type": "integer or string", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "boolean or string or integer or object", + "name": "value", + "description": "" + } + ] + }, + { + "type": "array of objects", + "name": "package_files", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "content_type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "download_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "md5", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "sha1", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "sha256", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "package_url", + "description": "" + }, + { + "type": "boolean", + "name": "prerelease", + "description": "" + }, + { + "type": "object", + "name": "release", + "description": "", + "childParamsGroups": [ + { + "type": "object or null", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tag_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_commitish", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array", + "name": "rubygems_metadata", + "description": "" + }, + { + "type": "string", + "name": "source_url", + "description": "" + }, + { + "type": "string", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tag_name", + "description": "" + }, + { + "type": "string", + "name": "target_commitish", + "description": "" + }, + { + "type": "string", + "name": "target_oid", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "version", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "registry", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "about_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "vendor", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "published", + "category": "package" + }, + "updated": { + "descriptionHtml": "A previously published package was updated.
", + "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "package", + "in": "body", + "description": "Information about the package.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ecosystem", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "namespace", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "package_type", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "package_version", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object or null", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body_html", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "docker_metadata", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "installation_command", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "manifest", + "description": "" + }, + { + "type": "array", + "name": "metadata", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "package_files", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "content_type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "download_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "md5", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "sha1", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha256", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "package_url", + "description": "" + }, + { + "type": "boolean", + "name": "prerelease", + "description": "" + }, + { + "type": "object", + "name": "release", + "description": "", + "childParamsGroups": [ + { + "type": "object or null", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tag_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_commitish", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array", + "name": "rubygems_metadata", + "description": "" + }, + { + "type": "string", + "name": "source_url", + "description": "" + }, + { + "type": "string", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tag_name", + "description": "" + }, + { + "type": "string", + "name": "target_commitish", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_oid", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "version", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "registry", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "about_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "vendor", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "updated", + "category": "package" + } + }, + "page_build": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"Configuring a publishing source for your GitHub Pages site.\" For information about the API to manage GitHub Pages, see \"Pages\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.
", + "bodyParameters": [ + { + "type": "object", + "name": "build", + "in": "body", + "description": "The List GitHub Pages builds itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "duration", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "error", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "message", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "pusher", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "id", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "page_build" + } + }, + "ping": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.
", + "bodyParameters": [ + { + "type": "object", + "name": "hook", + "in": "body", + "description": "The webhook that is being pinged
", + "childParamsGroups": [ + { + "type": "boolean", + "name": "active", + "description": "Determines whether the hook is actually triggered for the events it subscribes to.
", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.
" + }, + { + "type": "object", + "name": "config", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "content_type", + "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
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.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
The URL to which the payloads will be delivered.
" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deliveries_url", + "description": "" + }, + { + "type": "array of strings", + "name": "events", + "description": "Determines what events the hook is triggered for. Default: ['push'].
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the webhook.
", + "isRequired": true + }, + { + "type": "object", + "name": "last_response", + "description": "", + "childParamsGroups": [ + { + "type": "integer or null", + "name": "code", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "status", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "message", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The type of webhook. The only valid value is 'web'.
", + "isRequired": true, + "enum": [ + "web" + ] + }, + { + "type": "string", + "name": "ping_url", + "description": "" + }, + { + "type": "string", + "name": "test_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "hook_id", + "in": "body", + "description": "The ID of the webhook that triggered the ping.
" + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "zen", + "in": "body", + "description": "Random string of GitHub zen.
" + } + ], + "availability": [ + "repository", + "organization", + "app", + "business", + "marketplace" + ], + "action": "default", + "category": "ping" + } + }, + "project_card": { + "converted": { + "descriptionHtml": "A note in a classic project was converted to an issue.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "converted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "note", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project_card", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer or null", + "name": "after_id", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether or not the card is archived
", + "isRequired": true + }, + { + "type": "integer", + "name": "column_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "column_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_url", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "id", + "description": "The project card's ID
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "note", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "converted", + "category": "project_card" + }, + "created": { + "descriptionHtml": "A card was added to a classic project.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project_card", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer or null", + "name": "after_id", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether or not the card is archived
", + "isRequired": true + }, + { + "type": "integer", + "name": "column_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "column_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_url", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "id", + "description": "The project card's ID
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "note", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "project_card" + }, + "deleted": { + "descriptionHtml": "A card on a classic project was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project_card", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer or null", + "name": "after_id", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether or not the card is archived
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "column_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "column_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_url", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "id", + "description": "The project card's ID
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "note", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "project_card" + }, + "edited": { + "descriptionHtml": "A note on a classic project was edited.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "note", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project_card", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer or null", + "name": "after_id", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether or not the card is archived
", + "isRequired": true + }, + { + "type": "integer", + "name": "column_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "column_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_url", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "id", + "description": "The project card's ID
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "note", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "project_card" + }, + "moved": { + "descriptionHtml": "A card on a classic project was moved to another column or to another position in its column.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "moved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "column_id", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "project_card", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "moved", + "category": "project_card" + } + }, + "project": { + "closed": { + "descriptionHtml": "A classic project was closed.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "body", + "description": "Body of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "columns_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "owner_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the project; either 'open' or 'closed'
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "closed", + "category": "project" + }, + "created": { + "descriptionHtml": "A classic project was created.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "body", + "description": "Body of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "columns_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "owner_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the project; either 'open' or 'closed'
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "project" + }, + "deleted": { + "descriptionHtml": "A classic project was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "body", + "description": "Body of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "columns_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "owner_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the project; either 'open' or 'closed'
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "project" + }, + "edited": { + "descriptionHtml": "The name or description of a classic project was changed.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the project if the action was edited.
The previous version of the body if the action was edited.
The changes to the project if the action was edited.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "body", + "description": "Body of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "columns_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "owner_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the project; either 'open' or 'closed'
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "project" + }, + "reopened": { + "descriptionHtml": "A classic project was closed.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "body", + "description": "Body of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "columns_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "owner_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the project; either 'open' or 'closed'
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "project" + } + }, + "project_column": { + "created": { + "descriptionHtml": "A column was added to a classic project.
", + "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project_column", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer or null", + "name": "after_id", + "description": "" + }, + { + "type": "string", + "name": "cards_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the project column
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project column
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "project_column" + }, + "deleted": { + "descriptionHtml": "A column was deleted from a classic project.
", + "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project_column", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer or null", + "name": "after_id", + "description": "" + }, + { + "type": "string", + "name": "cards_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the project column
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project column
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "project_column" + }, + "edited": { + "descriptionHtml": "The name of a column on a classic project was changed.
", + "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "name", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project_column", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer or null", + "name": "after_id", + "description": "" + }, + { + "type": "string", + "name": "cards_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the project column
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project column
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "project_column" + }, + "moved": { + "descriptionHtml": "A column was moved to a new position on a classic project.
", + "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "moved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "project_column", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer or null", + "name": "after_id", + "description": "" + }, + { + "type": "string", + "name": "cards_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the project column
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the project column
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "project_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "moved", + "category": "project_column" + } + }, + "projects_v2": { + "closed": { + "descriptionHtml": "A project in the organization was closed.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2", + "in": "body", + "description": "A projects v2 project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "short_description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "deleted_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "deleted_by", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "closed", + "category": "projects_v2" + }, + "created": { + "descriptionHtml": "A project in the organization was created.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2", + "in": "body", + "description": "A projects v2 project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "short_description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "deleted_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "deleted_by", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "created", + "category": "projects_v2" + }, + "edited": { + "descriptionHtml": "The title, description, or README of a project in the organization was changed.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "description", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + }, + { + "type": "object", + "name": "public", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "from", + "description": "" + }, + { + "type": "boolean", + "name": "to", + "description": "" + } + ] + }, + { + "type": "object", + "name": "short_description", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + }, + { + "type": "object", + "name": "title", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "" + }, + { + "type": "string", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2", + "in": "body", + "description": "A projects v2 project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "short_description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "deleted_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "deleted_by", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "edited", + "category": "projects_v2" + }, + "reopened": { + "descriptionHtml": "A project in the organization was reopened.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2", + "in": "body", + "description": "A projects v2 project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "short_description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "deleted_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "deleted_by", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "reopened", + "category": "projects_v2" + } + }, + "projects_v2_item": { + "archived": { + "descriptionHtml": "An item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "archived" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "archived_at", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "An item belonging to a project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The type of content tracked in a project item
", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "archived", + "category": "projects_v2_item" + }, + "converted": { + "descriptionHtml": "A draft issue in an organization project was converted to an issue.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "converted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "content_type", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "An item belonging to a project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The type of content tracked in a project item
", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "converted", + "category": "projects_v2_item" + }, + "created": { + "descriptionHtml": "An item was added to a project in the organization.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "An item belonging to a project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The type of content tracked in a project item
", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "created", + "category": "projects_v2_item" + }, + "deleted": { + "descriptionHtml": "An item was deleted from a project in the organization.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "An item belonging to a project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The type of content tracked in a project item
", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "deleted", + "category": "projects_v2_item" + }, + "edited": { + "descriptionHtml": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object or object", + "name": "changes", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "An item belonging to a project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The type of content tracked in a project item
", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "edited", + "category": "projects_v2_item" + }, + "reordered": { + "descriptionHtml": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reordered" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "previous_projects_v2_item_node_id", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "An item belonging to a project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The type of content tracked in a project item
", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "reordered", + "category": "projects_v2_item" + }, + "restored": { + "descriptionHtml": "An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "restored" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "archived_at", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "" + }, + { + "type": "string or null", + "name": "to", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "projects_v2_item", + "in": "body", + "description": "An item belonging to a project
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "project_node_id", + "description": "" + }, + { + "type": "string", + "name": "content_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "The type of content tracked in a project item
", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "archived_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "organization" + ], + "action": "restored", + "category": "projects_v2_item" + } + }, + "public": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "public" + } + }, + "pull_request": { + "assigned": { + "descriptionHtml": "A pull request was assigned to a user.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "assigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "assigned", + "category": "pull_request" + }, + "auto_merge_disabled": { + "descriptionHtml": "Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "auto_merge_disabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "auto_merge_disabled", + "category": "pull_request" + }, + "auto_merge_enabled": { + "descriptionHtml": "Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "auto_merge_enabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "" + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "auto_merge_enabled", + "category": "pull_request" + }, + "closed": { + "descriptionHtml": "A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.
This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "closed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "closed", + "category": "pull_request" + }, + "converted_to_draft": { + "descriptionHtml": "A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "converted_to_draft" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "converted_to_draft", + "category": "pull_request" + }, + "demilestoned": { + "descriptionHtml": "A pull request was removed from a milestone.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "demilestoned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default.
", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default.
", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "demilestoned", + "category": "pull_request" + }, + "dequeued": { + "descriptionHtml": "A pull request was removed from the merge queue.
\nNote: The pull request merge queue feature is currently in limited public beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "dequeued" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "reason", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "dequeued", + "category": "pull_request" + }, + "edited": { + "descriptionHtml": "The title or body of a pull request was edited.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the comment if the action was edited.
The previous version of the body if the action was edited.
The previous version of the title if the action was edited.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "pull_request" + }, + "enqueued": { + "descriptionHtml": "A pull request was added to the merge queue.
\nNote: The pull request merge queue feature is currently in limited public beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "enqueued" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "enqueued", + "category": "pull_request" + }, + "labeled": { + "descriptionHtml": "A label was added to a pull request.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "labeled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "labeled", + "category": "pull_request" + }, + "locked": { + "descriptionHtml": "Conversation on a pull request was locked. For more information, see \"Locking conversations.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "locked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "locked", + "category": "pull_request" + }, + "milestoned": { + "descriptionHtml": "A pull request was added to a milestone.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "milestoned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "milestone", + "in": "body", + "description": "A collection of related issues and pull requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default.
", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default.
", + "default": false + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "milestoned", + "category": "pull_request" + }, + "opened": { + "descriptionHtml": "A pull request was created
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "opened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "opened", + "category": "pull_request" + }, + "ready_for_review": { + "descriptionHtml": "A draft pull request was marked as ready for review. For more information, see \"Changing the stage of a pull request.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "ready_for_review" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "ready_for_review", + "category": "pull_request" + }, + "reopened": { + "descriptionHtml": "A previously closed pull request was reopened.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "pull_request" + }, + "review_request_removed": { + "descriptionHtml": "A request for review by a person or team was removed from a pull request.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "review_request_removed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requested_reviewer", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "requested_team", + "in": "body", + "description": "Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "review_request_removed", + "category": "pull_request" + }, + "review_requested": { + "descriptionHtml": "Review by a person or team was requested for a pull request. For more information, see \"Requesting a pull request review.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "review_requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "requested_reviewer", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "requested_team", + "in": "body", + "description": "Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "review_requested", + "category": "pull_request" + }, + "synchronize": { + "descriptionHtml": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "synchronize" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "after", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "before", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "merge_commit_title", + "description": "The default value for a merge commit message title.
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "synchronize", + "category": "pull_request" + }, + "unassigned": { + "descriptionHtml": "A user was unassigned from a pull request.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unassigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unassigned", + "category": "pull_request" + }, + "unlabeled": { + "descriptionHtml": "A label was removed from a pull request.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + { + "type": "string", + "name": "merge_commit_title", + "description": "The default value for a merge commit message title.
", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlabeled", + "category": "pull_request" + }, + "unlocked": { + "descriptionHtml": "Conversation on a pull request was unlocked. For more information, see \"Locking conversations.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlocked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "number", + "in": "body", + "description": "The pull request number.
", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "integer", + "name": "additions", + "description": "" + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "" + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "" + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "" + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "" + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
" + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "" + }, + { + "type": "boolean or null", + "name": "merged", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "merged_by", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "" + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unlocked", + "category": "pull_request" + } + }, + "pull_request_review_comment": { + "created": { + "descriptionHtml": "A comment on a pull request diff was created.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "The comment itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "The text of the comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "The SHA of the commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_hunk", + "description": "The diff of the line that the comment refers to.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "HTML URL for the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "in_reply_to_id", + "description": "The comment ID to reply to.
" + }, + { + "type": "integer or null", + "name": "line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "original_commit_id", + "description": "The SHA of the original commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "original_line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "integer", + "name": "original_position", + "description": "The index of the original line in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "original_start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "The relative path of the file to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "The line index in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "pull_request_review_id", + "description": "The ID of the pull request review to which the comment belongs.
", + "isRequired": true + }, + { + "type": "string", + "name": "pull_request_url", + "description": "URL for the pull request that the review comment belongs to.
", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT" + ] + }, + { + "type": "integer or null", + "name": "start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "start_side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the pull request review comment
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "pull_request_review_comment" + }, + "deleted": { + "descriptionHtml": "A comment on a pull request diff was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "The comment itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "The text of the comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "The SHA of the commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_hunk", + "description": "The diff of the line that the comment refers to.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "HTML URL for the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "in_reply_to_id", + "description": "The comment ID to reply to.
" + }, + { + "type": "integer or null", + "name": "line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "original_commit_id", + "description": "The SHA of the original commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer", + "name": "original_line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "integer", + "name": "original_position", + "description": "The index of the original line in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "original_start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "The relative path of the file to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "The line index in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "pull_request_review_id", + "description": "The ID of the pull request review to which the comment belongs.
", + "isRequired": true + }, + { + "type": "string", + "name": "pull_request_url", + "description": "URL for the pull request that the review comment belongs to.
", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT" + ] + }, + { + "type": "integer or null", + "name": "start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "start_side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the pull request review comment
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "pull_request_review_comment" + }, + "edited": { + "descriptionHtml": "The content of a comment on a pull request diff was changed.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the comment.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the body.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "comment", + "in": "body", + "description": "The comment itself.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "The text of the comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "The SHA of the commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_hunk", + "description": "The diff of the line that the comment refers to.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "HTML URL for the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "in_reply_to_id", + "description": "The comment ID to reply to.
" + }, + { + "type": "integer or null", + "name": "line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "original_commit_id", + "description": "The SHA of the original commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer", + "name": "original_line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "integer", + "name": "original_position", + "description": "The index of the original line in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "original_start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "The relative path of the file to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "The line index in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "pull_request_review_id", + "description": "The ID of the pull request review to which the comment belongs.
", + "isRequired": true + }, + { + "type": "string", + "name": "pull_request_url", + "description": "URL for the pull request that the review comment belongs to.
", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT" + ] + }, + { + "type": "integer or null", + "name": "start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "start_side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the pull request review comment
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "pull_request_review_comment" + } + }, + "pull_request_review": { + "dismissed": { + "descriptionHtml": "A review on a pull request was dismissed.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "dismissed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "review", + "in": "body", + "description": "The review that was affected.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "The text of the review.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "A commit SHA for the review.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the review
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pull_request_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "dismissed", + "approved", + "changes_requested" + ] + }, + { + "type": "string", + "name": "submitted_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "dismissed", + "category": "pull_request_review" + }, + "edited": { + "descriptionHtml": "The body comment on a pull request review was edited.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the body if the action was edited.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "review", + "in": "body", + "description": "The review that was affected.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "The text of the review.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "A commit SHA for the review.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the review
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pull_request_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "submitted_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "pull_request_review" + }, + "submitted": { + "descriptionHtml": "A review on a pull request was submitted.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "submitted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merge_commit_message", + "description": "The default value for a merge commit message.
\nPR_TITLE - default to the pull request's title.PR_BODY - default to the pull request's body.BLANK - default to a blank commit message.The default value for a merge commit title.
\nPR_TITLE - default to the pull request's title.MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "squash_merge_commit_message", + "description": "The default value for a squash merge commit message:
\nPR_BODY - default to the pull request's body.COMMIT_MESSAGES - default to the branch's commit messages.BLANK - default to a blank commit message.The default value for a squash merge commit title:
\nPR_TITLE - default to the pull request's title.COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.
Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "review", + "in": "body", + "description": "The review that was affected.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "The text of the review.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "A commit SHA for the review.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the review
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pull_request_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "submitted_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "submitted", + "category": "pull_request_review" + } + }, + "pull_request_review_thread": { + "resolved": { + "descriptionHtml": "A comment thread on a pull request was marked as resolved.
", + "summaryHtml": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request review comment threads, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "resolved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "thread", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "The text of the comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "The SHA of the commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_hunk", + "description": "The diff of the line that the comment refers to.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "HTML URL for the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "in_reply_to_id", + "description": "The comment ID to reply to.
" + }, + { + "type": "integer or null", + "name": "line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "original_commit_id", + "description": "The SHA of the original commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "original_line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "integer", + "name": "original_position", + "description": "The index of the original line in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "original_start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "The relative path of the file to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "The line index in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "pull_request_review_id", + "description": "The ID of the pull request review to which the comment belongs.
", + "isRequired": true + }, + { + "type": "string", + "name": "pull_request_url", + "description": "URL for the pull request that the review comment belongs to.
", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT" + ] + }, + { + "type": "integer or null", + "name": "start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "start_side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the pull request review comment
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "resolved", + "category": "pull_request_review_thread" + }, + "unresolved": { + "descriptionHtml": "A previously resolved comment thread on a pull request was marked as unresolved.
", + "summaryHtml": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unresolved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pull_request", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "enabled_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "A git repository
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "allow_auto_merge", + "description": "Whether to allow auto-merge for pull requests.
", + "default": false + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "Whether to allow private forks
" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "Whether to allow merge commits for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "Whether to allow rebase merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "Whether to allow squash merges for pull requests.
", + "default": true + }, + { + "type": "boolean", + "name": "allow_update_branch", + "description": "" + }, + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "archived", + "description": "Whether the repository is archived.
", + "isRequired": true, + "default": false + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "The default branch of the repository.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "delete_branch_on_merge", + "description": "Whether to delete head branches when pull requests are merged
", + "default": false + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "Returns whether or not this repository is disabled.
" + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "Whether downloads are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "Whether issues are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "Whether projects are enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "Whether the wiki is enabled.
", + "isRequired": true, + "default": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "Whether discussions are enabled.
", + "isRequired": true, + "default": false + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organization", + "description": "" + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "public", + "description": "" + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "null or integer or string or integer or string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "role_name", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers", + "description": "" + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "", + "isRequired": true, + "enum": [ + "public", + "private", + "internal" + ] + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "Whether to require contributors to sign off on web-based commits
" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "requested_reviewers", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "requested_teams", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "thread", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "comments", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "html", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "The text of the comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_id", + "description": "The SHA of the commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_hunk", + "description": "The diff of the line that the comment refers to.
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "HTML URL for the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "The ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "integer", + "name": "in_reply_to_id", + "description": "The comment ID to reply to.
" + }, + { + "type": "integer or null", + "name": "line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node ID of the pull request review comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "original_commit_id", + "description": "The SHA of the original commit to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer", + "name": "original_line", + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", + "isRequired": true + }, + { + "type": "integer", + "name": "original_position", + "description": "The index of the original line in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "original_start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "The relative path of the file to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "position", + "description": "The line index in the diff to which the comment applies.
", + "isRequired": true + }, + { + "type": "integer or null", + "name": "pull_request_review_id", + "description": "The ID of the pull request review to which the comment belongs.
", + "isRequired": true + }, + { + "type": "string", + "name": "pull_request_url", + "description": "URL for the pull request that the review comment belongs to.
", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT" + ] + }, + { + "type": "integer or null", + "name": "start_line", + "description": "The first line of the range for a multi-line comment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "start_side", + "description": "The side of the first line of the range for a multi-line comment.
", + "isRequired": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the pull request review comment
", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unresolved", + "category": "pull_request_review_thread" + } + }, + "push": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a commit or tag is pushed.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\nNote: An event will not be created when more than three tags are pushed at once.
", + "bodyParameters": [ + { + "type": "string", + "name": "after", + "in": "body", + "description": "The SHA of the most recent commit on ref after the push.
The SHA of the most recent commit on ref before the push.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of files added in the commit.
" + }, + { + "type": "object", + "name": "author", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "object", + "name": "committer", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "distinct", + "description": "Whether this commit is distinct from any that have been pushed before.
", + "isRequired": true + }, + { + "type": "string", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "The commit message.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "modified", + "description": "An array of files modified by the commit.
" + }, + { + "type": "array of strings", + "name": "removed", + "description": "An array of files removed in the commit.
" + }, + { + "type": "string", + "name": "timestamp", + "description": "The ISO 8601 timestamp of the commit.
", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL that points to the commit API resource.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "compare", + "in": "body", + "description": "URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit.
Whether this push created the ref.
Whether this push deleted the ref.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "boolean", + "name": "forced", + "in": "body", + "description": "Whether this push was a force push of the ref.
An array of files added in the commit.
" + }, + { + "type": "object", + "name": "author", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "object", + "name": "committer", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "distinct", + "description": "Whether this commit is distinct from any that have been pushed before.
", + "isRequired": true + }, + { + "type": "string", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "The commit message.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "modified", + "description": "An array of files modified by the commit.
" + }, + { + "type": "array of strings", + "name": "removed", + "description": "An array of files removed in the commit.
" + }, + { + "type": "string", + "name": "timestamp", + "description": "The ISO 8601 timestamp of the commit.
", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL that points to the commit API resource.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "pusher", + "in": "body", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "The full git ref that was pushed. Example: refs/heads/main or refs/tags/v3.14.1.
A git repository
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "push" + } + }, + "registry_package": { + "published": { + "descriptionHtml": "A package was published to a registry.
", + "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\nNote: GitHub recommends that you use the newer package event instead.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "registry_package", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ecosystem", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "namespace", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "package_type", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "package_version", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or object", + "name": "body", + "description": "" + }, + { + "type": "string", + "name": "body_html", + "description": "" + }, + { + "type": "object", + "name": "container_metadata", + "description": "", + "childParamsGroups": [ + { + "type": "object or null", + "name": "labels", + "description": "" + }, + { + "type": "object or null", + "name": "manifest", + "description": "" + }, + { + "type": "object", + "name": "tag", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "digest", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + } + ] + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array", + "name": "docker_metadata", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "installation_command", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "manifest", + "description": "" + }, + { + "type": "array of objects", + "name": "metadata", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "npm_metadata", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "version", + "description": "" + }, + { + "type": "string", + "name": "npm_user", + "description": "" + }, + { + "type": "null or string or object", + "name": "author", + "description": "" + }, + { + "type": "null or string or object", + "name": "bugs", + "description": "" + }, + { + "type": "object", + "name": "dependencies", + "description": "" + }, + { + "type": "object", + "name": "dev_dependencies", + "description": "" + }, + { + "type": "object", + "name": "peer_dependencies", + "description": "" + }, + { + "type": "object", + "name": "optional_dependencies", + "description": "" + }, + { + "type": "string", + "name": "description", + "description": "" + }, + { + "type": "null or string or object", + "name": "dist", + "description": "" + }, + { + "type": "string", + "name": "git_head", + "description": "" + }, + { + "type": "string", + "name": "homepage", + "description": "" + }, + { + "type": "string", + "name": "license", + "description": "" + }, + { + "type": "string", + "name": "main", + "description": "" + }, + { + "type": "null or string or object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "scripts", + "description": "" + }, + { + "type": "string", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "node_version", + "description": "" + }, + { + "type": "string", + "name": "npm_version", + "description": "" + }, + { + "type": "boolean", + "name": "has_shrinkwrap", + "description": "" + }, + { + "type": "array of strings", + "name": "maintainers", + "description": "" + }, + { + "type": "array of strings", + "name": "contributors", + "description": "" + }, + { + "type": "object", + "name": "engines", + "description": "" + }, + { + "type": "array of strings", + "name": "keywords", + "description": "" + }, + { + "type": "array of strings", + "name": "files", + "description": "" + }, + { + "type": "object", + "name": "bin", + "description": "" + }, + { + "type": "object", + "name": "man", + "description": "" + }, + { + "type": "null or string or object", + "name": "directories", + "description": "" + }, + { + "type": "array of strings", + "name": "os", + "description": "" + }, + { + "type": "array of strings", + "name": "cpu", + "description": "" + }, + { + "type": "string", + "name": "readme", + "description": "" + }, + { + "type": "string", + "name": "installation_command", + "description": "" + }, + { + "type": "integer", + "name": "release_id", + "description": "" + }, + { + "type": "string", + "name": "commit_oid", + "description": "" + }, + { + "type": "boolean", + "name": "published_via_actions", + "description": "" + }, + { + "type": "integer", + "name": "deleted_by_id", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "nuget_metadata", + "description": "", + "childParamsGroups": [ + { + "type": "null or string or object or integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "boolean or string or integer or object", + "name": "value", + "description": "" + } + ] + }, + { + "type": "array of objects", + "name": "package_files", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "content_type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "download_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "md5", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "sha1", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "sha256", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "package_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "" + }, + { + "type": "object", + "name": "release", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "boolean", + "name": "prerelease", + "description": "" + }, + { + "type": "string", + "name": "published_at", + "description": "" + }, + { + "type": "string", + "name": "tag_name", + "description": "" + }, + { + "type": "string", + "name": "target_commitish", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "array", + "name": "rubygems_metadata", + "description": "" + }, + { + "type": "string", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tag_name", + "description": "" + }, + { + "type": "string", + "name": "target_commitish", + "description": "" + }, + { + "type": "string", + "name": "target_oid", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "version", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "registry", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "about_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "vendor", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "published", + "category": "registry_package" + }, + "default": { + "descriptionHtml": "A package that was previously published to a registry was updated.
", + "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\nNote: GitHub recommends that you use the newer package event instead
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "registry_package", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ecosystem", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "namespace", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "package_type", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "package_version", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "body_html", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of nulls", + "name": "docker_metadata", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "installation_command", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "manifest", + "description": "" + }, + { + "type": "array", + "name": "metadata", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "package_files", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "content_type", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "" + }, + { + "type": "string", + "name": "download_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string or null", + "name": "md5", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "sha1", + "description": "" + }, + { + "type": "string", + "name": "sha256", + "description": "" + }, + { + "type": "integer", + "name": "size", + "description": "" + }, + { + "type": "string", + "name": "state", + "description": "" + }, + { + "type": "string", + "name": "updated_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "package_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "" + }, + { + "type": "object", + "name": "release", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tag_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_commitish", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array", + "name": "rubygems_metadata", + "description": "" + }, + { + "type": "string", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tag_name", + "description": "" + }, + { + "type": "string", + "name": "target_commitish", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_oid", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "version", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "registry", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "registry_package" + } + }, + "release": { + "created": { + "descriptionHtml": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "release", + "in": "body", + "description": "The release object.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assets", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "browser_download_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "download_count", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The file name of the asset.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the release asset.
", + "isRequired": true, + "enum": [ + "uploaded" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "uploader", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "assets_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "discussion_url", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "Whether the release is a draft or published
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "Whether the release is identified as a prerelease or a full release.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "tag_name", + "description": "The name of the tag.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "tarball_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_commitish", + "description": "Specifies the commitish value that determines where the Git tag is created from.
", + "isRequired": true + }, + { + "type": "string", + "name": "upload_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "zipball_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "release" + }, + "deleted": { + "descriptionHtml": "A release, pre-release, or draft release was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "release", + "in": "body", + "description": "The release object.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assets", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "browser_download_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "download_count", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The file name of the asset.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the release asset.
", + "isRequired": true, + "enum": [ + "uploaded" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "uploader", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "assets_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "discussion_url", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "Whether the release is a draft or published
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "Whether the release is identified as a prerelease or a full release.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "tag_name", + "description": "The name of the tag.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "tarball_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_commitish", + "description": "Specifies the commitish value that determines where the Git tag is created from.
", + "isRequired": true + }, + { + "type": "string", + "name": "upload_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "zipball_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "release" + }, + "edited": { + "descriptionHtml": "The details of a release, pre-release, or draft release were edited. For more information, see \"Managing releases in a repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the body if the action was edited.
The previous version of the name if the action was edited.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "release", + "in": "body", + "description": "The release object.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assets", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "browser_download_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "download_count", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The file name of the asset.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the release asset.
", + "isRequired": true, + "enum": [ + "uploaded" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "uploader", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "assets_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "discussion_url", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "Whether the release is a draft or published
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "Whether the release is identified as a prerelease or a full release.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "tag_name", + "description": "The name of the tag.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "tarball_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_commitish", + "description": "Specifies the commitish value that determines where the Git tag is created from.
", + "isRequired": true + }, + { + "type": "string", + "name": "upload_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "zipball_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "release" + }, + "prereleased": { + "descriptionHtml": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "prereleased" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "release", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "prereleased", + "category": "release" + }, + "published": { + "descriptionHtml": "A release, pre-release, or draft of a release was published.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "published" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "release", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "published", + "category": "release" + }, + "released": { + "descriptionHtml": "A release was published, or a pre-release was changed to a release.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "released" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "release", + "in": "body", + "description": "The release object.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assets", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "browser_download_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "download_count", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The file name of the asset.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of the release asset.
", + "isRequired": true, + "enum": [ + "uploaded" + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "uploader", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "assets_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "discussion_url", + "description": "" + }, + { + "type": "boolean", + "name": "draft", + "description": "Whether the release is a draft or published
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "prerelease", + "description": "Whether the release is identified as a prerelease or a full release.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "tag_name", + "description": "The name of the tag.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "tarball_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "target_commitish", + "description": "Specifies the commitish value that determines where the Git tag is created from.
", + "isRequired": true + }, + { + "type": "string", + "name": "upload_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "zipball_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "released", + "category": "release" + }, + "unpublished": { + "descriptionHtml": "A release or pre-release was unpublished.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unpublished" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "", + "name": "release", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unpublished", + "category": "release" + } + }, + "repository": { + "archived": { + "descriptionHtml": "A repository was archived.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "archived" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "archived", + "category": "repository" + }, + "created": { + "descriptionHtml": "A repository was created.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "created", + "category": "repository" + }, + "deleted": { + "descriptionHtml": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "deleted", + "category": "repository" + }, + "edited": { + "descriptionHtml": "The topics, default branch, description, or homepage of a repository was changed.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "default_branch", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "description", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "homepage", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "from", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "topics", + "description": "", + "childParamsGroups": [ + { + "type": "array of strings or null", + "name": "from", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "edited", + "category": "repository" + }, + "privatized": { + "descriptionHtml": "The visibility of a repository was changed to private.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "privatized" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "privatized", + "category": "repository" + }, + "publicized": { + "descriptionHtml": "The visibility of a repository was changed to public.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "publicized" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "publicized", + "category": "repository" + }, + "renamed": { + "descriptionHtml": "The name of a repository was changed.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "renamed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "repository", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "name", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "", + "isRequired": true + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "renamed", + "category": "repository" + }, + "transferred": { + "descriptionHtml": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "transferred" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "public_members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object or null", + "name": "user", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "transferred", + "category": "repository" + }, + "unarchived": { + "descriptionHtml": "A previously archived repository was unarchived.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unarchived" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "unarchived", + "category": "repository" + }, + "anonymous_access_disabled": { + "descriptionHtml": "Someone disabled anonymous Git read access to the repository. For more information, see \"Enabling anonymous Git read access for a repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_disabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "app", + "business", + "organization", + "repository" + ], + "action": "anonymous_access_disabled", + "category": "repository" + }, + "anonymous_access_enabled": { + "descriptionHtml": "Someone enabled anonymous Git read access to the repository. For more information, see \"Enabling anonymous Git read access for a repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_enabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "app", + "business", + "organization", + "repository" + ], + "action": "anonymous_access_enabled", + "category": "repository" + } + }, + "repository_dispatch": { + "default": { + "descriptionHtml": "The event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.
This event occurs when a GitHub App sends a POST request to /repos/{owner}/{repo}/dispatches. For more information, see the REST API documentation for creating a repository dispatch event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "branch", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "client_payload", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "repository_dispatch" + } + }, + "repository_import": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"Importing a repository with GitHub Importer.\" For more information about the API to manage imports, see the REST API documentation.
", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "status", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "success", + "cancelled", + "failure" + ] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "default", + "category": "repository_import" + } + }, + "repository_vulnerability_alert": { + "create": { + "descriptionHtml": "A repository vulnerability alert was created.
", + "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\nNote: This event is deprecated. Use the dependabot_alert event instead.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "create", + "category": "repository_vulnerability_alert" + }, + "dismiss": { + "descriptionHtml": "A repository vulnerability alert was dismissed.
", + "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\nNote: This event is deprecated. Use the dependabot_alert event instead.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "dismiss", + "category": "repository_vulnerability_alert" + }, + "reopen": { + "descriptionHtml": "A previously dismissed or resolved repository vulnerability alert was reopened.
", + "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\nNote: This event is deprecated. Use the dependabot_alert event instead.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "reopen", + "category": "repository_vulnerability_alert" + }, + "resolve": { + "descriptionHtml": "A repository vulnerability alert was marked as resolved.
", + "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\nNote: This event is deprecated. Use the dependabot_alert event instead.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "resolve", + "category": "repository_vulnerability_alert" + } + }, + "secret_scanning_alert": { + "created": { + "descriptionHtml": "A secret scanning alert was created.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string", + "name": "state", + "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "secret_scanning_alert" + }, + "reopened": { + "descriptionHtml": "A previously closed secret scanning alert was reopened.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string", + "name": "state", + "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "secret_scanning_alert" + }, + "resolved": { + "descriptionHtml": "A secret scanning alert was closed.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "resolved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution", + "description": "Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret", + "description": "The secret that was detected.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "resolved", + "category": "secret_scanning_alert" + }, + "revoked": { + "descriptionHtml": "A secret scanning alert was marked as revoked.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "revoked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string", + "name": "state", + "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "revoked", + "category": "secret_scanning_alert" + } + }, + "secret_scanning_alert_location": { + "created": { + "descriptionHtml": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.
", + "summaryHtml": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.
\nFor more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alerts, use the secret_scanning_alert event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string", + "name": "state", + "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "location", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.
", + "isRequired": true, + "enum": [ + "commit", + "issue_title", + "issue_body", + "issue_comment" + ] + }, + { + "type": "object or object or object or object", + "name": "details", + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "secret_scanning_alert_location" + } + }, + "security_advisory": { + "published": { + "descriptionHtml": "A security advisory was published to the GitHub community.
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "published" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "security_advisory", + "in": "body", + "description": "The details of the security advisory, including summary, description, and severity.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "cvss", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ghsa_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "value", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "references", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object or null", + "name": "first_patched_version", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "package", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "withdrawn_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "published", + "category": "security_advisory" + }, + "updated": { + "descriptionHtml": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "updated" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "security_advisory", + "in": "body", + "description": "The details of the security advisory, including summary, description, and severity.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "cvss", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ghsa_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "value", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "references", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object or null", + "name": "first_patched_version", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "package", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "withdrawn_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "updated", + "category": "security_advisory" + }, + "withdrawn": { + "descriptionHtml": "A previously published security advisory was withdrawn.
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "withdrawn" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "security_advisory", + "in": "body", + "description": "The details of the security advisory, including summary, description, and severity.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "cvss", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "number", + "name": "score", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "vector_string", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects", + "name": "cwes", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "cwe_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ghsa_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "identifiers", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "value", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "published_at", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "references", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "summary", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "vulnerabilities", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object or null", + "name": "first_patched_version", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "identifier", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "package", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ecosystem", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "severity", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "vulnerable_version_range", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "withdrawn_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "withdrawn", + "category": "security_advisory" + } + }, + "security_and_analysis": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"GitHub security features.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "bodyParameters": [ + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "", + "childParamsGroups": [ + { + "type": "object or null", + "name": "security_and_analysis", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "advanced_security", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, + { + "type": "object", + "name": "secret_scanning_push_protection", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "", + "enum": [ + "enabled", + "disabled" + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "Full Repository
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "security_and_analysis" + } + }, + "sponsorship": { + "cancelled": { + "descriptionHtml": "A sponsorship was cancelled and the last billing cycle has ended.
\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "cancelled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sponsorship", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "maintainer", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "privacy_level", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "sponsor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "sponsorable", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "tier", + "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sponsorship", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "maintainer", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "privacy_level", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "sponsor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "sponsorable", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "tier", + "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "privacy_level", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The edited event types include the details about the change when someone edits a sponsorship to change the privacy.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sponsorship", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "maintainer", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "privacy_level", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "sponsor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "sponsorable", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "tier", + "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.
\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "pending_cancellation" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "effective_date", + "in": "body", + "description": "The pending_cancellation and pending_tier_change event types will include the date the cancellation or tier change will take effect.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sponsorship", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "maintainer", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "privacy_level", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "sponsor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "sponsorable", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "tier", + "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "pending_tier_change" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "tier", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
The pending_cancellation and pending_tier_change event types will include the date the cancellation or tier change will take effect.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sponsorship", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "maintainer", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "privacy_level", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "sponsor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "sponsorable", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "tier", + "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "tier_changed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "tier", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "from", + "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sponsorship", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "maintainer", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "privacy_level", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "sponsor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object or null", + "name": "sponsorable", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "tier", + "description": "The tier_changed and pending_tier_change will include the original tier before the change or pending change. For more information, see the pending tier change payload.
Someone starred a repository.
", + "summaryHtml": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string or null", + "name": "starred_at", + "in": "body", + "description": "The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.
Someone unstarred the repository.
", + "summaryHtml": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "null", + "name": "starred_at", + "in": "body", + "description": "The time the star was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Will be null for the deleted action.
This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "bodyParameters": [ + { + "type": "string or null", + "name": "avatar_url", + "in": "body", + "description": "" + }, + { + "type": "array of objects", + "name": "branches", + "in": "body", + "description": "An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "commit", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "protected", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commit", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object or null", + "name": "author", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "commit", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "", + "name": "author", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comment_count", + "description": "", + "isRequired": true + }, + { + "type": "", + "name": "committer", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "tree", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "verification", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "reason", + "description": "", + "isRequired": true, + "enum": [ + "expired_key", + "not_signing_key", + "gpgverify_error", + "gpgverify_unavailable", + "unsigned", + "unknown_signature_type", + "no_user", + "unverified_email", + "bad_email", + "unknown_key", + "malformed_signature", + "invalid", + "valid", + "bad_cert", + "ocsp_pending" + ] + }, + { + "type": "string or null", + "name": "signature", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "verified", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object or null", + "name": "committer", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "parents", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "context", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "The optional human-readable description added to the status.
", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "integer", + "name": "id", + "in": "body", + "description": "The unique identifier of the status.
", + "isRequired": true + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "name", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "sha", + "in": "body", + "description": "The Commit SHA.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "in": "body", + "description": "The new state. Can be pending, success, failure, or error.
The optional link added to the status.
", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "in": "body", + "description": "", + "isRequired": true + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "status" + } + }, + "team_add": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a team is added to a repository.\nFor more information, see \"Managing teams and people with access to your repository.\"
\nFor activity relating to teams, see the teams event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "team", + "in": "body", + "description": "Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "team_add" + } + }, + "team": { + "added_to_repository": { + "descriptionHtml": "A team was granted access to a repository.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "added_to_repository" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A git repository
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "team", + "in": "body", + "description": "Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "added_to_repository", + "category": "team" + }, + "created": { + "descriptionHtml": "A team was created.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A git repository
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "team", + "in": "body", + "description": "Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "created", + "category": "team" + }, + "deleted": { + "descriptionHtml": "A team was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A git repository
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "team", + "in": "body", + "description": "Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "deleted", + "category": "team" + }, + "edited": { + "descriptionHtml": "The name, description, or visibility of a team was changed.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "edited" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "changes", + "in": "body", + "description": "The changes to the team if the action was edited.
The previous version of the description if the action was edited.
The previous version of the name if the action was edited.
The previous version of the team's privacy if the action was edited.
The previous version of the team member's admin permission on a repository, if the action was edited.
The previous version of the team member's pull permission on a repository, if the action was edited.
The previous version of the team member's push permission on a repository, if the action was edited.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A git repository
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "team", + "in": "body", + "description": "Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "edited", + "category": "team" + }, + "removed_from_repository": { + "descriptionHtml": "A team's access to a repository was removed.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "removed_from_repository" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A git repository
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "team", + "in": "body", + "description": "Groups of organization members that gives permissions on specified repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "object or null", + "name": "parent", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "", + "isRequired": true, + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
" + }, + { + "type": "string", + "name": "privacy", + "description": "", + "enum": [ + "open", + "closed", + "secret" + ] + }, + { + "type": "string", + "name": "repositories_url", + "description": "" + }, + { + "type": "string", + "name": "slug", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
" + } + ] + } + ], + "availability": [ + "organization", + "business", + "app" + ], + "action": "removed_from_repository", + "category": "team" + } + }, + "watch": { + "started": { + "descriptionHtml": "Someone started watching the repository.
", + "summaryHtml": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"Managing your subscriptions.\" For information about the APIs to manage watching, see \"Watching\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "started" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "started", + "category": "watch" + } + }, + "workflow_dispatch": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"Manually running a workflow.\"
\nFor activity relating to workflow runs, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "bodyParameters": [ + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "inputs", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "number", + "description": "" + } + ] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "name": "workflow", + "in": "body", + "description": "", + "isRequired": true + } + ], + "availability": [ + "app" + ], + "action": "default", + "category": "workflow_dispatch" + } + }, + "workflow_job": { + "completed": { + "descriptionHtml": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "completed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "", + "name": "workflow_job", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "A request for a specific ref(branch,sha,tag) to be deployed
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "The ref to deploy. This can be a branch, tag, or sha.
", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "completed", + "category": "workflow_job" + }, + "in_progress": { + "descriptionHtml": "A job in a workflow run started processing on a runner.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "in_progress" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "", + "name": "workflow_job", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "A request for a specific ref(branch,sha,tag) to be deployed
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "The ref to deploy. This can be a branch, tag, or sha.
", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "in_progress", + "category": "workflow_job" + }, + "queued": { + "descriptionHtml": "A job in a workflow run was created.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "queued" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "workflow_job", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "check_run_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "number", + "name": "run_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "runner_group_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "runner_group_name", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "runner_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "runner_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "waiting" + ] + }, + { + "type": "string or null", + "name": "head_branch", + "description": "The name of the current branch.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "workflow_name", + "description": "The name of the workflow.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "steps", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "failure", + "skipped", + "success", + "cancelled", + null + ] + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "completed", + "in_progress", + "queued", + "pending" + ] + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "A request for a specific ref(branch,sha,tag) to be deployed
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "The ref to deploy. This can be a branch, tag, or sha.
", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "queued", + "category": "workflow_job" + }, + "waiting": { + "descriptionHtml": "A job in a workflow run was created and is waiting for approvals.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow.
\nFor more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, see the workflow_run event.
To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "waiting" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "workflow_job", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "check_run_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "number", + "name": "run_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "runner_group_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "runner_group_name", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "runner_id", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "runner_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "The name of the current branch.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "workflow_name", + "description": "The name of the workflow.
", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "queued", + "in_progress", + "completed", + "waiting" + ] + }, + { + "type": "array of objects", + "name": "steps", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "completed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "failure", + "skipped", + "success", + "cancelled", + null + ] + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "completed", + "in_progress", + "queued", + "pending", + "waiting" + ] + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "A request for a specific ref(branch,sha,tag) to be deployed
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "The ref to deploy. This can be a branch, tag, or sha.
", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_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.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "waiting", + "category": "workflow_job" + } + }, + "workflow_run": { + "completed": { + "descriptionHtml": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
", + "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "completed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "workflow", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "badge_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "", + "name": "workflow_run", + "in": "body", + "description": "", + "isRequired": true + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "completed", + "category": "workflow_run" + }, + "in_progress": { + "descriptionHtml": "A workflow run started processing on a runner.
", + "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "in_progress" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "workflow", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "badge_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "", + "name": "workflow_run", + "in": "body", + "description": "", + "isRequired": true + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "in_progress", + "category": "workflow_run" + }, + "requested": { + "descriptionHtml": "A workflow run was triggered.
", + "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "workflow", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "badge_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "workflow_run", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object or null", + "name": "actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "artifacts_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "cancel_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "check_suite_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_suite_node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "check_suite_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "conclusion", + "description": "", + "isRequired": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "event", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "head_branch", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "head_commit", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "author", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "object", + "name": "committer", + "description": "Metaproperties for Git author/committer information.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "date", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The git author's name.
", + "isRequired": true + }, + { + "type": "string", + "name": "username", + "description": "" + } + ] + }, + { + "type": "string", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "message", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "timestamp", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tree_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "head_repository", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "head_sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "jobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "logs_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "previous_attempt_url", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "pull_requests", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "number", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "number", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "array of objects or null", + "name": "referenced_workflows", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "path", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "" + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "rerun_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_attempt", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "run_number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "run_started_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "status", + "description": "", + "isRequired": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "pending", + "waiting" + ] + }, + { + "type": "object or null", + "name": "triggering_actor", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "workflow_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "workflow_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "display_title", + "description": "", + "isRequired": true + } + ] + } + ], + "availability": [ + "business", + "repository", + "organization", + "app" + ], + "action": "requested", + "category": "workflow_run" + } + }, + "cache_sync": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "after", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "before", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "cache_location", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "ref", + "in": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "default", + "category": "cache_sync" + } + }, + "enterprise": { + "anonymous_access_disabled": { + "descriptionHtml": "Anonymous Git read access was disabled.
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_disabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business" + ], + "action": "anonymous_access_disabled", + "category": "enterprise" + }, + "anonymous_access_enabled": { + "descriptionHtml": "Anonymous Git read access was enabled.
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_enabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business" + ], + "action": "anonymous_access_enabled", + "category": "enterprise" + } + }, + "user": { + "created": { + "descriptionHtml": "A user account was added to the enterprise.
", + "summaryHtml": "This event occurs when there is activity relating to user accounts in an enterprise.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "user", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ], + "availability": [ + "business" + ], + "action": "created", + "category": "user" + }, + "deleted": { + "descriptionHtml": "A user account was removed from the enterprise.
", + "summaryHtml": "This event occurs when there is activity relating to user accounts in an enterprise.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "user", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ], + "availability": [ + "business" + ], + "action": "deleted", + "category": "user" + } + } +} \ No newline at end of file diff --git a/lib/webhooks/static/decorated/github.ae.json b/lib/webhooks/static/decorated/github.ae.json index 86b36d9c951d..5557c18c1d12 100644 --- a/lib/webhooks/static/decorated/github.ae.json +++ b/lib/webhooks/static/decorated/github.ae.json @@ -32243,7 +32243,7 @@ "installation": { "created": { "descriptionHtml": "Someone installed a GitHub App on a user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32460,7 +32460,7 @@ }, "deleted": { "descriptionHtml": "Someone uninstalled a GitHub App from their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32563,7 +32563,7 @@ }, "new_permissions_accepted": { "descriptionHtml": "Someone granted new permissions to a GitHub App.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32666,7 +32666,7 @@ }, "suspend": { "descriptionHtml": "Someone blocked access by a GitHub App to their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32769,7 +32769,7 @@ }, "unsuspend": { "descriptionHtml": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -32874,7 +32874,7 @@ "installation_repositories": { "added": { "descriptionHtml": "A GitHub App installation was granted access to one or more repositories.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -33138,7 +33138,7 @@ }, "removed": { "descriptionHtml": "Access to one or more repositories was revoked for a GitHub App installation.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -56982,7 +56982,7 @@ "merge_group": { "default": { "descriptionHtml": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.
\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.
", - "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in limited private beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.
\nNote: The pull request merge queue feature is currently in public beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -67797,8 +67797,8 @@ }, "projects_v2_item": { "archived": { - "descriptionHtml": "An item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "descriptionHtml": "An item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -68059,7 +68059,7 @@ }, "converted": { "descriptionHtml": "A draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -68320,7 +68320,7 @@ }, "created": { "descriptionHtml": "An item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -68555,7 +68555,7 @@ }, "deleted": { "descriptionHtml": "An item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -68790,7 +68790,7 @@ }, "edited": { "descriptionHtml": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -69031,7 +69031,7 @@ }, "reordered": { "descriptionHtml": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -69291,8 +69291,8 @@ "category": "projects_v2_item" }, "restored": { - "descriptionHtml": "An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "descriptionHtml": "An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -154689,7 +154689,7 @@ "category": "repository" }, "transferred": { - "descriptionHtml": "Ownership of the repository was transferred to a user or organization account.
", + "descriptionHtml": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { @@ -157091,7 +157091,7 @@ "security_advisory": { "published": { "descriptionHtml": "A security advisory was published to the GitHub community.
", - "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", @@ -157327,7 +157327,7 @@ }, "updated": { "descriptionHtml": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.
", - "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", @@ -157563,7 +157563,7 @@ }, "withdrawn": { "descriptionHtml": "A previously published security advisory was withdrawn.
", - "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", @@ -165091,7 +165091,7 @@ }, "waiting": { "descriptionHtml": "A job in a workflow run was created and is waiting for approvals.
", - "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow.
\nFor more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, see the workflow_run event.
To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow.
\nFor more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, see the workflow_run event.
To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.
", "bodyParameters": [ { "type": "string", @@ -167717,7 +167717,7 @@ "cache_sync": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", + "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", "bodyParameters": [ { "type": "string", @@ -167795,7 +167795,7 @@ "enterprise": { "anonymous_access_disabled": { "descriptionHtml": "Anonymous Git read access was disabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "bodyParameters": [ { "type": "string", @@ -167824,7 +167824,7 @@ }, "anonymous_access_enabled": { "descriptionHtml": "Anonymous Git read access was enabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "bodyParameters": [ { "type": "string", diff --git a/middleware/contextualizers/features.js b/middleware/contextualizers/features.js index 0de51a878179..c05c71329ed3 100644 --- a/middleware/contextualizers/features.js +++ b/middleware/contextualizers/features.js @@ -1,3 +1,6 @@ +import path from 'path' + +import { ROOT } from '../../lib/constants.js' import getApplicableVersions from '../../lib/get-applicable-versions.js' import { getDeepDataByLanguage } from '../../lib/get-data.js' @@ -29,7 +32,10 @@ function getFeaturesByVersion(currentVersion) { // Determine whether the currentVersion belongs to the list of versions the feature is available in. for (const [featureName, feature] of Object.entries(allFeatures)) { const { versions } = feature - const applicableVersions = getApplicableVersions(versions, `data/features/${featureName}.yml`) + const applicableVersions = getApplicableVersions( + versions, + path.join(ROOT, `data/features/${featureName}.yml`) + ) // Adding the resulting boolean to the context object gives us the ability to use // `{% if featureName ... %}` conditionals in content files. diff --git a/middleware/contextualizers/ghes-release-notes.js b/middleware/contextualizers/ghes-release-notes.js index 6edf54974b24..e3c38fa62779 100644 --- a/middleware/contextualizers/ghes-release-notes.js +++ b/middleware/contextualizers/ghes-release-notes.js @@ -1,5 +1,6 @@ import { formatReleases, renderPatchNotes } from '../../lib/release-notes-utils.js' import { all } from '../../lib/enterprise-server-releases.js' +import { executeWithFallback } from '../../lib/render-with-fallback.js' import { getReleaseNotes } from './get-release-notes.js' export default async function ghesReleaseNotesContext(req, res, next) { @@ -28,7 +29,21 @@ export default async function ghesReleaseNotesContext(req, res, next) { // Run the current release notes through the markdown rendering pipeline. // Returns the current release's patches array: [{version, patchVersion, intro, date, sections}] - req.context.ghesReleaseNotes = await renderPatchNotes(currentReleaseNotes, req.context) + req.context.ghesReleaseNotes = await executeWithFallback( + req.context, + () => renderPatchNotes(currentReleaseNotes, req.context), + (enContext) => { + // Something in the release notes ultimately caused a Liquid + // rendering error. Let's start over and gather the English release + // notes instead. + const ghesReleaseNotes = getReleaseNotes('enterprise-server', 'en') + enContext.ghesReleases = formatReleases(ghesReleaseNotes) + const currentReleaseNotes = enContext.ghesReleases.find( + (r) => r.version === requestedRelease + ).patches + return renderPatchNotes(currentReleaseNotes, enContext) + } + ) // GHES release notes on docs started with 2.20 but older release notes exist on enterprise.github.com. // So we want to use _all_ GHES versions when calculating next and previous releases. diff --git a/middleware/dynamic-assets.js b/middleware/dynamic-assets.js new file mode 100644 index 000000000000..46ebccb0bc04 --- /dev/null +++ b/middleware/dynamic-assets.js @@ -0,0 +1,116 @@ +import fs from 'fs/promises' + +import sharp from 'sharp' + +import { assetCacheControl, defaultCacheControl } from './cache-control.js' +import { setFastlySurrogateKey, SURROGATE_ENUMS } from './set-fastly-surrogate-key.js' + +export default async function dynamicAssets(req, res, next) { + if (!req.url.startsWith('/assets/')) return next() + + if (!(req.method === 'GET' || req.method === 'HEAD')) { + return res.status(405).type('text/plain').send('Method Not Allowed') + } + + // To protect from possible denial of service, we never allow what + // we're going to do (the image file operation), if the whole thing + // won't be aggressively cached. + // If we didn't do this, someone making 2 requests, ... + // + // > GET /assets/images/site/logo.web?random=10476583 + // > GET /assets/images/site/logo.web?random=20196996 + // + // ...would be treated as 2 distinct backend requests. Sure, each one + // would be cached in the CDN, but that's not helping if someone does... + // + // while (true) { + // startFetchThread(`/assets/images/site/logo.web?whatever=${rand()}`) + // } + // + // So we "force" any deviation of the URL to a redirect to the canonical + // URL (which, again, is heavily cached). + if (Object.keys(req.query).length > 0) { + // Cache the 404 so it won't be re-attempted over and over + defaultCacheControl(res) + + // This redirects to the same URL we're currently on, but with the + // query string part omitted. + // For example: + // + // > GET /assets/images/site/logo.web?foo=bar + // < 302 + // < location: /assets/images/site/logo.web + // + return res.redirect(302, req.path) + } + + if (req.path.endsWith('.webp')) { + // From PNG (if it exists) to WEBP + try { + const originalBuffer = await fs.readFile(req.path.slice(1).replace(/\.webp$/, '.png')) + const buffer = await sharp(originalBuffer) + // Note that by default, sharp will use a lossy compression. + // (i.e. `{lossless: false}` in the options) + // The difference is that a lossless image is slightly crisper + // but becomes on average 1.8x larger. + // Given how we serve images, no human would be able to tell the + // difference simply by looking at the image as it appears as an + // image tag in the web page. + // Also given that rendering-for-viewing is the "end of the line" + // for the image meaning it just ends up being viewed and not + // resaved as a source file. If we had intention to overwrite all + // original PNG source files to WEBP, we should consier lossless + // to preserve as much quality as possible at the source level. + // The default quality is 80% which, combined with `lossless:false` + // makes our images 2.8x smaller than the average PNG. + .webp() + .toBuffer() + assetCacheControl(res) + return res.type('image/webp').send(buffer) + } catch (error) { + if (error.code !== 'ENOENT') { + throw error + } + } + } + + if (req.path.endsWith('.avif')) { + // From PNG (if it exists) to AVIF + try { + const originalBuffer = await fs.readFile(req.path.slice(1).replace(/\.avif$/, '.png')) + const buffer = await sharp(originalBuffer) + .avif({ + // The default is 4 (max is 9). Because this is a dynamic thing + // and AVIF encoding is slow for large images, go for a smaller + // effort to be sure it can't take too long on a busy server. + effort: 2, + }) + .toBuffer() + assetCacheControl(res) + return res.type('image/avif').send(buffer) + } catch (error) { + if (error.code !== 'ENOENT') { + throw error + } + } + } + + // Cache the 404 so it won't be re-attempted over and over + defaultCacheControl(res) + + // There's a preceeding middleware that sets the Surrogate-Key to + // "manual-purge" based on the URL possibly having the `/cb-xxxxx/` + // checksum in it. But, if it failed, we don't want that. So + // undo that if it was set. + // It's handy too to not overly cache 404s in the CDN because + // it could be that the next prod deployment fixes the missing image. + // For example, a PR landed that introduced the *reference* to the image + // but forgot to check in the new image, then a follow-up PR adds the image. + setFastlySurrogateKey(res, SURROGATE_ENUMS.DEFAULT) + + // Don't use something like `next(404)` because we don't want a fancy + // HTML "Page not found" page response because a failed asset lookup + // is impossibly a typo in the browser address bar or an accidentally + // broken link, like it might be to a regular HTML page. + res.status(404).type('text/plain').send('Asset not found') +} diff --git a/middleware/find-page.js b/middleware/find-page.js index eae0bab518f2..7e1097cddd9e 100644 --- a/middleware/find-page.js +++ b/middleware/find-page.js @@ -1,12 +1,13 @@ import path from 'path' import { existsSync } from 'fs' +import { ROOT } from '../lib/constants.js' import Page from '../lib/page.js' import { languageKeys } from '../lib/languages.js' const languagePrefixRegex = new RegExp(`^/(${languageKeys.join('|')})(/|$)`) const englishPrefixRegex = /^\/en(\/|$)/ -const CONTENT_ROOT = 'content' +const CONTENT_ROOT = path.join(ROOT, 'content') export default async function findPage( req, diff --git a/middleware/handle-errors.js b/middleware/handle-errors.js index 7db2c7ff4257..a2270296e885 100644 --- a/middleware/handle-errors.js +++ b/middleware/handle-errors.js @@ -3,6 +3,8 @@ import { nextApp } from './next.js' import { setFastlySurrogateKey, SURROGATE_ENUMS } from './set-fastly-surrogate-key.js' import { errorCacheControl } from './cache-control.js' +const DEBUG_MIDDLEWARE_TESTS = Boolean(JSON.parse(process.env.DEBUG_MIDDLEWARE_TESTS || 'false')) + function shouldLogException(error) { const IGNORED_ERRORS = [ // Client connected aborted @@ -43,7 +45,7 @@ export default async function handleError(error, req, res, next) { // loading all the middlewares. setFastlySurrogateKey(res, SURROGATE_ENUMS.DEFAULT) } - } else if (process.env.NODE_ENV === 'test') { + } else if (DEBUG_MIDDLEWARE_TESTS) { console.warn('An error occurrred in some middleware handler', error) } diff --git a/middleware/index.js b/middleware/index.js index 6b329a2f1a8e..34f1d5e4a587 100644 --- a/middleware/index.js +++ b/middleware/index.js @@ -61,6 +61,7 @@ import fastHead from './fast-head.js' import fastlyCacheTest from './fastly-cache-test.js' import trailingSlashes from './trailing-slashes.js' import fastlyBehavior from './fastly-behavior.js' +import dynamicAssets from './dynamic-assets.js' const { DEPLOYMENT_ENV, NODE_ENV } = process.env const isTest = NODE_ENV === 'test' || process.env.GITHUB_ACTIONS === 'true' @@ -155,12 +156,11 @@ export default function (app) { // URLs with a cache busting prefix. maxAge: '7 days', immutable: process.env.NODE_ENV !== 'development', - // This means, that if you request a file that starts with /assets/ - // any file doesn't exist, don't bother (NextJS) rendering a - // pretty HTML error page. - fallthrough: false, + // The next middleware will try its luck and send the 404 if must. + fallthrough: true, }) ) + app.use(asyncMiddleware(instrument(dynamicAssets, './dynamic-assets'))) app.use( '/public/', express.static('data/graphql', { diff --git a/next.config.js b/next.config.js index 50aa6fcec002..e096412938a5 100644 --- a/next.config.js +++ b/next.config.js @@ -3,8 +3,9 @@ import path from 'path' import frontmatter from 'gray-matter' import { languageKeys } from './lib/languages.js' +import { ROOT } from './lib/constants.js' -const homepage = path.posix.join(process.cwd(), 'content/index.md') +const homepage = path.posix.join(ROOT, 'content/index.md') const { data } = frontmatter(fs.readFileSync(homepage, 'utf8')) const productIds = data.children diff --git a/package-lock.json b/package-lock.json index 123d2fb081d5..626d82974355 100644 --- a/package-lock.json +++ b/package-lock.json @@ -28,6 +28,7 @@ "dotenv": "^16.0.1", "express": "^4.18.1", "express-timeout-handler": "^2.2.2", + "fastest-levenshtein": "1.0.16", "file-type": "18.2.0", "flat": "^5.0.2", "github-slugger": "^2.0.0", @@ -41,7 +42,7 @@ "helmet": "^6.0.0", "highlight.js": "11.7.0", "highlightjs-curl": "^1.3.0", - "hot-shots": "^9.0.0", + "hot-shots": "^10.0.0", "html-entities": "^2.3.3", "http-proxy-middleware": "2.0.6", "imurmurhash": "^0.1.4", @@ -79,6 +80,7 @@ "rss-parser": "^3.12.0", "scroll-anchoring": "^0.1.0", "semver": "^7.3.7", + "sharp": "0.31.3", "slash": "^5.0.0", "strip-html-comments": "^1.0.0", "styled-components": "^5.3.5", @@ -111,8 +113,8 @@ "@types/react-dom": "^18.0.5", "@types/react-syntax-highlighter": "^15.5.2", "@types/uuid": "^9.0.0", - "@typescript-eslint/eslint-plugin": "5.48.0", - "@typescript-eslint/parser": "5.48.0", + "@typescript-eslint/eslint-plugin": "5.50.0", + "@typescript-eslint/parser": "5.50.0", "babel-loader": "^9.0.1", "babel-plugin-styled-components": "^2.0.7", "babel-preset-env": "^1.7.0", @@ -122,7 +124,7 @@ "cross-env": "^7.0.3", "csp-parse": "0.0.2", "dedent": "^0.7.0", - "eslint": "8.31.0", + "eslint": "8.33.0", "eslint-config-prettier": "^8.5.0", "eslint-config-standard": "^17.0.0", "eslint-plugin-import": "^2.26.0", @@ -4711,15 +4713,16 @@ } }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.48.0.tgz", - "integrity": "sha512-SVLafp0NXpoJY7ut6VFVUU9I+YeFsDzeQwtK0WZ+xbRN3mtxJ08je+6Oi2N89qDn087COdO0u3blKZNv9VetRQ==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.50.0.tgz", + "integrity": "sha512-vwksQWSFZiUhgq3Kv7o1Jcj0DUNylwnIlGvKvLLYsq8pAWha6/WCnXUeaSoNNha/K7QSf2+jvmkxggC1u3pIwQ==", "dev": true, "dependencies": { - "@typescript-eslint/scope-manager": "5.48.0", - "@typescript-eslint/type-utils": "5.48.0", - "@typescript-eslint/utils": "5.48.0", + "@typescript-eslint/scope-manager": "5.50.0", + "@typescript-eslint/type-utils": "5.50.0", + "@typescript-eslint/utils": "5.50.0", "debug": "^4.3.4", + "grapheme-splitter": "^1.0.4", "ignore": "^5.2.0", "natural-compare-lite": "^1.4.0", "regexpp": "^3.2.0", @@ -4761,14 +4764,14 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.48.0.tgz", - "integrity": "sha512-1mxNA8qfgxX8kBvRDIHEzrRGrKHQfQlbW6iHyfHYS0Q4X1af+S6mkLNtgCOsGVl8+/LUPrqdHMssAemkrQ01qg==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.50.0.tgz", + "integrity": "sha512-KCcSyNaogUDftK2G9RXfQyOCt51uB5yqC6pkUYqhYh8Kgt+DwR5M0EwEAxGPy/+DH6hnmKeGsNhiZRQxjH71uQ==", "dev": true, "dependencies": { - "@typescript-eslint/scope-manager": "5.48.0", - "@typescript-eslint/types": "5.48.0", - "@typescript-eslint/typescript-estree": "5.48.0", + "@typescript-eslint/scope-manager": "5.50.0", + "@typescript-eslint/types": "5.50.0", + "@typescript-eslint/typescript-estree": "5.50.0", "debug": "^4.3.4" }, "engines": { @@ -4805,13 +4808,13 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.48.0.tgz", - "integrity": "sha512-0AA4LviDtVtZqlyUQnZMVHydDATpD9SAX/RC5qh6cBd3xmyWvmXYF+WT1oOmxkeMnWDlUVTwdODeucUnjz3gow==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.50.0.tgz", + "integrity": "sha512-rt03kaX+iZrhssaT974BCmoUikYtZI24Vp/kwTSy841XhiYShlqoshRFDvN1FKKvU2S3gK+kcBW1EA7kNUrogg==", "dev": true, "dependencies": { - "@typescript-eslint/types": "5.48.0", - "@typescript-eslint/visitor-keys": "5.48.0" + "@typescript-eslint/types": "5.50.0", + "@typescript-eslint/visitor-keys": "5.50.0" }, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" @@ -4822,13 +4825,13 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.48.0.tgz", - "integrity": "sha512-vbtPO5sJyFjtHkGlGK4Sthmta0Bbls4Onv0bEqOGm7hP9h8UpRsHJwsrCiWtCUndTRNQO/qe6Ijz9rnT/DB+7g==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.50.0.tgz", + "integrity": "sha512-dcnXfZ6OGrNCO7E5UY/i0ktHb7Yx1fV6fnQGGrlnfDhilcs6n19eIRcvLBqx6OQkrPaFlDPk3OJ0WlzQfrV0bQ==", "dev": true, "dependencies": { - "@typescript-eslint/typescript-estree": "5.48.0", - "@typescript-eslint/utils": "5.48.0", + "@typescript-eslint/typescript-estree": "5.50.0", + "@typescript-eslint/utils": "5.50.0", "debug": "^4.3.4", "tsutils": "^3.21.0" }, @@ -4866,9 +4869,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.48.0.tgz", - "integrity": "sha512-UTe67B0Ypius0fnEE518NB2N8gGutIlTojeTg4nt0GQvikReVkurqxd2LvYa9q9M5MQ6rtpNyWTBxdscw40Xhw==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.50.0.tgz", + "integrity": "sha512-atruOuJpir4OtyNdKahiHZobPKFvZnBnfDiyEaBf6d9vy9visE7gDjlmhl+y29uxZ2ZDgvXijcungGFjGGex7w==", "dev": true, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" @@ -4879,13 +4882,13 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.48.0.tgz", - "integrity": "sha512-7pjd94vvIjI1zTz6aq/5wwE/YrfIyEPLtGJmRfyNR9NYIW+rOvzzUv3Cmq2hRKpvt6e9vpvPUQ7puzX7VSmsEw==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.50.0.tgz", + "integrity": "sha512-Gq4zapso+OtIZlv8YNAStFtT6d05zyVCK7Fx3h5inlLBx2hWuc/0465C2mg/EQDDU2LKe52+/jN4f0g9bd+kow==", "dev": true, "dependencies": { - "@typescript-eslint/types": "5.48.0", - "@typescript-eslint/visitor-keys": "5.48.0", + "@typescript-eslint/types": "5.50.0", + "@typescript-eslint/visitor-keys": "5.50.0", "debug": "^4.3.4", "globby": "^11.1.0", "is-glob": "^4.0.3", @@ -4923,16 +4926,16 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.48.0.tgz", - "integrity": "sha512-x2jrMcPaMfsHRRIkL+x96++xdzvrdBCnYRd5QiW5Wgo1OB4kDYPbC1XjWP/TNqlfK93K/lUL92erq5zPLgFScQ==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.50.0.tgz", + "integrity": "sha512-v/AnUFImmh8G4PH0NDkf6wA8hujNNcrwtecqW4vtQ1UOSNBaZl49zP1SHoZ/06e+UiwzHpgb5zP5+hwlYYWYAw==", "dev": true, "dependencies": { "@types/json-schema": "^7.0.9", "@types/semver": "^7.3.12", - "@typescript-eslint/scope-manager": "5.48.0", - "@typescript-eslint/types": "5.48.0", - "@typescript-eslint/typescript-estree": "5.48.0", + "@typescript-eslint/scope-manager": "5.50.0", + "@typescript-eslint/types": "5.50.0", + "@typescript-eslint/typescript-estree": "5.50.0", "eslint-scope": "^5.1.1", "eslint-utils": "^3.0.0", "semver": "^7.3.7" @@ -4967,12 +4970,12 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.48.0.tgz", - "integrity": "sha512-5motVPz5EgxQ0bHjut3chzBkJ3Z3sheYVcSwS5BpHZpLqSptSmELNtGixmgj65+rIfhvtQTz5i9OP2vtzdDH7Q==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.50.0.tgz", + "integrity": "sha512-cdMeD9HGu6EXIeGOh2yVW6oGf9wq8asBgZx7nsR/D36gTfQ0odE5kcRYe5M81vjEFAcPeugXrHg78Imu55F6gg==", "dev": true, "dependencies": { - "@typescript-eslint/types": "5.48.0", + "@typescript-eslint/types": "5.50.0", "eslint-visitor-keys": "^3.3.0" }, "engines": { @@ -6362,8 +6365,7 @@ "type": "consulting", "url": "https://feross.org/support" } - ], - "optional": true + ] }, "node_modules/basic-auth": { "version": "2.0.1", @@ -6396,11 +6398,19 @@ "node": ">=8" } }, + "node_modules/bindings": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.5.0.tgz", + "integrity": "sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==", + "optional": true, + "dependencies": { + "file-uri-to-path": "1.0.0" + } + }, "node_modules/bl": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", - "optional": true, "dependencies": { "buffer": "^5.5.0", "inherits": "^2.0.4", @@ -6677,7 +6687,6 @@ "url": "https://feross.org/support" } ], - "optional": true, "dependencies": { "base64-js": "^1.3.1", "ieee754": "^1.1.13" @@ -7000,8 +7009,7 @@ "node_modules/chownr": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.1.4.tgz", - "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==", - "optional": true + "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==" }, "node_modules/chrome-trace-event": { "version": "1.0.3", @@ -7202,9 +7210,20 @@ "integrity": "sha512-iBPtljfCNcTKNAto0KEtDfZ3qzjJvqE3aTGZsbhjSBlorqpXJlaWWtPO35D+ZImoC3KWejX64o+yPGxhWSTzfg==", "dev": true }, + "node_modules/color": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/color/-/color-4.2.3.tgz", + "integrity": "sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==", + "dependencies": { + "color-convert": "^2.0.1", + "color-string": "^1.9.0" + }, + "engines": { + "node": ">=12.5.0" + } + }, "node_modules/color-convert": { "version": "2.0.1", - "devOptional": true, "license": "MIT", "dependencies": { "color-name": "~1.1.4" @@ -7215,9 +7234,17 @@ }, "node_modules/color-name": { "version": "1.1.4", - "devOptional": true, "license": "MIT" }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } + }, "node_modules/color2k": { "version": "1.2.4", "license": "MIT" @@ -7658,7 +7685,6 @@ "version": "0.6.0", "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", - "dev": true, "engines": { "node": ">=4.0.0" } @@ -7726,6 +7752,14 @@ "npm": "1.2.8000 || >= 1.4.16" } }, + "node_modules/detect-libc": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.1.tgz", + "integrity": "sha512-463v3ZeIrcWtdgIg6vI6XUncguvr2TnGl4SzDXinkt9mSLpBJKXT3mW6xT3VQdDN11+WVs29pgvivTc4Lp8v+w==", + "engines": { + "node": ">=8" + } + }, "node_modules/detect-newline": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", @@ -8077,9 +8111,9 @@ } }, "node_modules/eslint": { - "version": "8.31.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.31.0.tgz", - "integrity": "sha512-0tQQEVdmPZ1UtUKXjX7EMm9BlgJ08G90IhWh0PKDCb3ZLsgAOHI8fYSIzYVZej92zsgq+ft0FGsxhJ3xo2tbuA==", + "version": "8.33.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.33.0.tgz", + "integrity": "sha512-WjOpFQgKK8VrCnAtl8We0SUOy/oVZ5NHykyMiagV1M9r8IFpIJX7DduK6n1mpfhlG7T1NLWm2SuD8QB7KFySaA==", "dev": true, "dependencies": { "@eslint/eslintrc": "^1.4.1", @@ -8940,6 +8974,14 @@ "node": ">= 0.8.0" } }, + "node_modules/expand-template": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/expand-template/-/expand-template-2.0.3.tgz", + "integrity": "sha512-XYfuKMvj4O35f/pOXLObndIRvyQ+/+6AhODh+OKWj9S9498pHHn/IMszH+gt0fBCRWMNfk1ZSp5x3AifmnI2vg==", + "engines": { + "node": ">=6" + } + }, "node_modules/expand-tilde": { "version": "1.2.2", "devOptional": true, @@ -9311,6 +9353,14 @@ "url": "https://paypal.me/naturalintelligence" } }, + "node_modules/fastest-levenshtein": { + "version": "1.0.16", + "resolved": "https://registry.npmjs.org/fastest-levenshtein/-/fastest-levenshtein-1.0.16.tgz", + "integrity": "sha512-eRnCtTTtGZFpQCwhJiUOuxPQWRXVKYDn0b2PeHfXL6/Zi53SLAzAHfVhVWK2AryC/WH05kGfxhFIPvTF0SXQzg==", + "engines": { + "node": ">= 4.9.1" + } + }, "node_modules/fastq": { "version": "1.13.0", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", @@ -9376,6 +9426,12 @@ "url": "https://github.com/sindresorhus/file-type?sponsor=1" } }, + "node_modules/file-uri-to-path": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", + "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==", + "optional": true + }, "node_modules/fill-range": { "version": "7.0.1", "license": "MIT", @@ -9678,8 +9734,7 @@ "node_modules/fs-constants": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs-constants/-/fs-constants-1.0.0.tgz", - "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==", - "optional": true + "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==" }, "node_modules/fs-exists-sync": { "version": "0.1.0", @@ -9931,6 +9986,11 @@ "node": ">=4" } }, + "node_modules/github-from-package": { + "version": "0.0.0", + "resolved": "https://registry.npmjs.org/github-from-package/-/github-from-package-0.0.0.tgz", + "integrity": "sha512-SyHy3T1v2NUXn29OsWdxmK6RwHD+vkj3v8en8AOBZ1wBQ/hCAQ5bAQTD02kW4W9tUp/3Qh6J8r9EvntiyCmOOw==" + }, "node_modules/github-slugger": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-2.0.0.tgz", @@ -10584,13 +10644,14 @@ } }, "node_modules/hot-shots": { - "version": "9.0.0", - "license": "MIT", + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/hot-shots/-/hot-shots-10.0.0.tgz", + "integrity": "sha512-uy/uGpuJk7yuyiKRfZMBNkF1GAOX5O2ifO9rDCaX9jw8fu6eW9QeWC7WRPDI+O98frW1HQgV3+xwjWsZPECIzQ==", "engines": { - "node": ">=6.0.0" + "node": ">=10.0.0" }, "optionalDependencies": { - "unix-dgram": "2.0.x" + "unix-dgram": "2.x" } }, "node_modules/hpagent": { @@ -10647,8 +10708,9 @@ } }, "node_modules/http-cache-semantics": { - "version": "4.1.0", - "license": "BSD-2-Clause" + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", + "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==" }, "node_modules/http-proxy": { "version": "1.18.1", @@ -10901,7 +10963,6 @@ }, "node_modules/ini": { "version": "1.3.8", - "devOptional": true, "license": "ISC" }, "node_modules/inline-style-parser": { @@ -15527,7 +15588,6 @@ }, "node_modules/minimist": { "version": "1.2.6", - "devOptional": true, "license": "MIT" }, "node_modules/minimist-options": { @@ -15581,8 +15641,7 @@ "node_modules/mkdirp-classic": { "version": "0.5.3", "resolved": "https://registry.npmjs.org/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz", - "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==", - "optional": true + "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==" }, "node_modules/mockdate": { "version": "3.0.5", @@ -15676,6 +15735,12 @@ "msgpack5": "^3.3.0" } }, + "node_modules/nan": { + "version": "2.17.0", + "resolved": "https://registry.npmjs.org/nan/-/nan-2.17.0.tgz", + "integrity": "sha512-2ZTgtl0nJsO0KQCjEpxcIr5D+Yv90plTitZt9JBfQvVJDS5seMl3FOvsh3+9CoYWXf/1l5OaZzzF6nDm4cagaQ==", + "optional": true + }, "node_modules/nanoid": { "version": "3.3.4", "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.4.tgz", @@ -15687,6 +15752,11 @@ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" } }, + "node_modules/napi-build-utils": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/napi-build-utils/-/napi-build-utils-1.0.2.tgz", + "integrity": "sha512-ONmRUqK7zj7DWX0D9ADe03wbwOBZxNAfF20PlGfCWQcD3+/MakShIHrMqx9YwPTfxDdF1zLeL+RGZiR9kGMLdg==" + }, "node_modules/natural-compare": { "version": "1.4.0", "dev": true, @@ -15789,6 +15859,22 @@ "node": ">= 10.13" } }, + "node_modules/node-abi": { + "version": "3.31.0", + "resolved": "https://registry.npmjs.org/node-abi/-/node-abi-3.31.0.tgz", + "integrity": "sha512-eSKV6s+APenqVh8ubJyiu/YhZgxQpGP66ntzUb3lY1xB9ukSRaGnx0AIxI+IM+1+IVYC1oWobgG5L3Lt9ARykQ==", + "dependencies": { + "semver": "^7.3.5" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/node-addon-api": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-5.1.0.tgz", + "integrity": "sha512-eh0GgfEkpnoWDq+VY8OyvYhFEzBk6jIYbRKdIlyTiAXIVJ8PyBaKb0rp7oDtoddbdoHWhq8wwr+XZ81F1rpNdA==" + }, "node_modules/node-fetch": { "version": "2.6.7", "devOptional": true, @@ -16598,6 +16684,31 @@ "version": "4.1.0", "license": "MIT" }, + "node_modules/prebuild-install": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/prebuild-install/-/prebuild-install-7.1.1.tgz", + "integrity": "sha512-jAXscXWMcCK8GgCoHOfIr0ODh5ai8mj63L2nWrjuAgXE6tDyYGnx4/8o/rCgU+B4JSyZBKbeZqzhtwtC3ovxjw==", + "dependencies": { + "detect-libc": "^2.0.0", + "expand-template": "^2.0.3", + "github-from-package": "0.0.0", + "minimist": "^1.2.3", + "mkdirp-classic": "^0.5.3", + "napi-build-utils": "^1.0.1", + "node-abi": "^3.3.0", + "pump": "^3.0.0", + "rc": "^1.2.7", + "simple-get": "^4.0.0", + "tar-fs": "^2.0.0", + "tunnel-agent": "^0.6.0" + }, + "bin": { + "prebuild-install": "bin.js" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/prelude-ls": { "version": "1.2.1", "dev": true, @@ -17010,7 +17121,6 @@ "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", - "dev": true, "dependencies": { "deep-extend": "^0.6.0", "ini": "~1.3.0", @@ -17025,7 +17135,6 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", - "dev": true, "engines": { "node": ">=0.10.0" } @@ -18186,9 +18295,9 @@ "integrity": "sha512-ZQruFgZnIWH+WyO9t5rWt4ZEGqCKPwhiw+YbzTwpmT9elgLrLcfuyUiSnwwjUiVy9r4VM3urtbNF1xmEh9IL2w==" }, "node_modules/semver": { - "version": "7.3.7", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.7.tgz", - "integrity": "sha512-QlYTucUYOews+WeEujDoEGziz4K6c47V/Bd+LjSSYcA94p+DmINdf7ncaUinThfvZyu13lN9OY1XDxt8C0Tw0g==", + "version": "7.3.8", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", + "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", "dependencies": { "lru-cache": "^6.0.0" }, @@ -18391,6 +18500,28 @@ "version": "1.1.0", "license": "MIT" }, + "node_modules/sharp": { + "version": "0.31.3", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.31.3.tgz", + "integrity": "sha512-XcR4+FCLBFKw1bdB+GEhnUNXNXvnt0tDo4WsBsraKymuo/IAuPuCBVAL2wIkUw2r/dwFW5Q5+g66Kwl2dgDFVg==", + "hasInstallScript": true, + "dependencies": { + "color": "^4.2.3", + "detect-libc": "^2.0.1", + "node-addon-api": "^5.0.0", + "prebuild-install": "^7.1.1", + "semver": "^7.3.8", + "simple-get": "^4.0.1", + "tar-fs": "^2.1.1", + "tunnel-agent": "^0.6.0" + }, + "engines": { + "node": ">=14.15.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, "node_modules/shebang-command": { "version": "2.0.0", "dev": true, @@ -18495,6 +18626,62 @@ "devOptional": true, "license": "ISC" }, + "node_modules/simple-concat": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/simple-concat/-/simple-concat-1.0.1.tgz", + "integrity": "sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/simple-get": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/simple-get/-/simple-get-4.0.1.tgz", + "integrity": "sha512-brv7p5WgH0jmQJr1ZDDfKDOSeWWg+OVypG99A/5vYGPqJ6pxiaHLy8nxtFjBA7oMa01ebA9gfh1uMCFqOuXxvA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "decompress-response": "^6.0.0", + "once": "^1.3.1", + "simple-concat": "^1.0.0" + } + }, + "node_modules/simple-swizzle": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz", + "integrity": "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==", + "dependencies": { + "is-arrayish": "^0.3.1" + } + }, + "node_modules/simple-swizzle/node_modules/is-arrayish": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz", + "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==" + }, "node_modules/simple-update-notifier": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/simple-update-notifier/-/simple-update-notifier-1.0.7.tgz", @@ -19137,7 +19324,6 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.1.tgz", "integrity": "sha512-V0r2Y9scmbDRLCNex/+hYzvp/zyYjvFbHPNgVTKfQvVrb6guiE/fxP+XblDNR011utopbkex2nM4dHNV6GDsng==", - "optional": true, "dependencies": { "chownr": "^1.1.1", "mkdirp-classic": "^0.5.2", @@ -19149,7 +19335,6 @@ "version": "2.2.0", "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-2.2.0.tgz", "integrity": "sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ==", - "optional": true, "dependencies": { "bl": "^4.0.3", "end-of-stream": "^1.4.1", @@ -19515,6 +19700,17 @@ "node": ">=0.6.11 <=0.7.0 || >=0.7.3" } }, + "node_modules/tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w==", + "dependencies": { + "safe-buffer": "^5.0.1" + }, + "engines": { + "node": "*" + } + }, "node_modules/type-check": { "version": "0.4.0", "dev": true, @@ -19858,6 +20054,20 @@ "node": ">= 10.0.0" } }, + "node_modules/unix-dgram": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/unix-dgram/-/unix-dgram-2.0.6.tgz", + "integrity": "sha512-AURroAsb73BZ6CdAyMrTk/hYKNj3DuYYEuOaB8bYMOHGKupRNScw90Q5C71tWJc3uE7dIeXRyuwN0xLLq3vDTg==", + "hasInstallScript": true, + "optional": true, + "dependencies": { + "bindings": "^1.5.0", + "nan": "^2.16.0" + }, + "engines": { + "node": ">=0.10.48" + } + }, "node_modules/unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", @@ -24174,15 +24384,16 @@ } }, "@typescript-eslint/eslint-plugin": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.48.0.tgz", - "integrity": "sha512-SVLafp0NXpoJY7ut6VFVUU9I+YeFsDzeQwtK0WZ+xbRN3mtxJ08je+6Oi2N89qDn087COdO0u3blKZNv9VetRQ==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.50.0.tgz", + "integrity": "sha512-vwksQWSFZiUhgq3Kv7o1Jcj0DUNylwnIlGvKvLLYsq8pAWha6/WCnXUeaSoNNha/K7QSf2+jvmkxggC1u3pIwQ==", "dev": true, "requires": { - "@typescript-eslint/scope-manager": "5.48.0", - "@typescript-eslint/type-utils": "5.48.0", - "@typescript-eslint/utils": "5.48.0", + "@typescript-eslint/scope-manager": "5.50.0", + "@typescript-eslint/type-utils": "5.50.0", + "@typescript-eslint/utils": "5.50.0", "debug": "^4.3.4", + "grapheme-splitter": "^1.0.4", "ignore": "^5.2.0", "natural-compare-lite": "^1.4.0", "regexpp": "^3.2.0", @@ -24202,14 +24413,14 @@ } }, "@typescript-eslint/parser": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.48.0.tgz", - "integrity": "sha512-1mxNA8qfgxX8kBvRDIHEzrRGrKHQfQlbW6iHyfHYS0Q4X1af+S6mkLNtgCOsGVl8+/LUPrqdHMssAemkrQ01qg==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.50.0.tgz", + "integrity": "sha512-KCcSyNaogUDftK2G9RXfQyOCt51uB5yqC6pkUYqhYh8Kgt+DwR5M0EwEAxGPy/+DH6hnmKeGsNhiZRQxjH71uQ==", "dev": true, "requires": { - "@typescript-eslint/scope-manager": "5.48.0", - "@typescript-eslint/types": "5.48.0", - "@typescript-eslint/typescript-estree": "5.48.0", + "@typescript-eslint/scope-manager": "5.50.0", + "@typescript-eslint/types": "5.50.0", + "@typescript-eslint/typescript-estree": "5.50.0", "debug": "^4.3.4" }, "dependencies": { @@ -24225,23 +24436,23 @@ } }, "@typescript-eslint/scope-manager": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.48.0.tgz", - "integrity": "sha512-0AA4LviDtVtZqlyUQnZMVHydDATpD9SAX/RC5qh6cBd3xmyWvmXYF+WT1oOmxkeMnWDlUVTwdODeucUnjz3gow==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.50.0.tgz", + "integrity": "sha512-rt03kaX+iZrhssaT974BCmoUikYtZI24Vp/kwTSy841XhiYShlqoshRFDvN1FKKvU2S3gK+kcBW1EA7kNUrogg==", "dev": true, "requires": { - "@typescript-eslint/types": "5.48.0", - "@typescript-eslint/visitor-keys": "5.48.0" + "@typescript-eslint/types": "5.50.0", + "@typescript-eslint/visitor-keys": "5.50.0" } }, "@typescript-eslint/type-utils": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.48.0.tgz", - "integrity": "sha512-vbtPO5sJyFjtHkGlGK4Sthmta0Bbls4Onv0bEqOGm7hP9h8UpRsHJwsrCiWtCUndTRNQO/qe6Ijz9rnT/DB+7g==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.50.0.tgz", + "integrity": "sha512-dcnXfZ6OGrNCO7E5UY/i0ktHb7Yx1fV6fnQGGrlnfDhilcs6n19eIRcvLBqx6OQkrPaFlDPk3OJ0WlzQfrV0bQ==", "dev": true, "requires": { - "@typescript-eslint/typescript-estree": "5.48.0", - "@typescript-eslint/utils": "5.48.0", + "@typescript-eslint/typescript-estree": "5.50.0", + "@typescript-eslint/utils": "5.50.0", "debug": "^4.3.4", "tsutils": "^3.21.0" }, @@ -24258,19 +24469,19 @@ } }, "@typescript-eslint/types": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.48.0.tgz", - "integrity": "sha512-UTe67B0Ypius0fnEE518NB2N8gGutIlTojeTg4nt0GQvikReVkurqxd2LvYa9q9M5MQ6rtpNyWTBxdscw40Xhw==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.50.0.tgz", + "integrity": "sha512-atruOuJpir4OtyNdKahiHZobPKFvZnBnfDiyEaBf6d9vy9visE7gDjlmhl+y29uxZ2ZDgvXijcungGFjGGex7w==", "dev": true }, "@typescript-eslint/typescript-estree": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.48.0.tgz", - "integrity": "sha512-7pjd94vvIjI1zTz6aq/5wwE/YrfIyEPLtGJmRfyNR9NYIW+rOvzzUv3Cmq2hRKpvt6e9vpvPUQ7puzX7VSmsEw==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.50.0.tgz", + "integrity": "sha512-Gq4zapso+OtIZlv8YNAStFtT6d05zyVCK7Fx3h5inlLBx2hWuc/0465C2mg/EQDDU2LKe52+/jN4f0g9bd+kow==", "dev": true, "requires": { - "@typescript-eslint/types": "5.48.0", - "@typescript-eslint/visitor-keys": "5.48.0", + "@typescript-eslint/types": "5.50.0", + "@typescript-eslint/visitor-keys": "5.50.0", "debug": "^4.3.4", "globby": "^11.1.0", "is-glob": "^4.0.3", @@ -24290,16 +24501,16 @@ } }, "@typescript-eslint/utils": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.48.0.tgz", - "integrity": "sha512-x2jrMcPaMfsHRRIkL+x96++xdzvrdBCnYRd5QiW5Wgo1OB4kDYPbC1XjWP/TNqlfK93K/lUL92erq5zPLgFScQ==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.50.0.tgz", + "integrity": "sha512-v/AnUFImmh8G4PH0NDkf6wA8hujNNcrwtecqW4vtQ1UOSNBaZl49zP1SHoZ/06e+UiwzHpgb5zP5+hwlYYWYAw==", "dev": true, "requires": { "@types/json-schema": "^7.0.9", "@types/semver": "^7.3.12", - "@typescript-eslint/scope-manager": "5.48.0", - "@typescript-eslint/types": "5.48.0", - "@typescript-eslint/typescript-estree": "5.48.0", + "@typescript-eslint/scope-manager": "5.50.0", + "@typescript-eslint/types": "5.50.0", + "@typescript-eslint/typescript-estree": "5.50.0", "eslint-scope": "^5.1.1", "eslint-utils": "^3.0.0", "semver": "^7.3.7" @@ -24317,12 +24528,12 @@ } }, "@typescript-eslint/visitor-keys": { - "version": "5.48.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.48.0.tgz", - "integrity": "sha512-5motVPz5EgxQ0bHjut3chzBkJ3Z3sheYVcSwS5BpHZpLqSptSmELNtGixmgj65+rIfhvtQTz5i9OP2vtzdDH7Q==", + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.50.0.tgz", + "integrity": "sha512-cdMeD9HGu6EXIeGOh2yVW6oGf9wq8asBgZx7nsR/D36gTfQ0odE5kcRYe5M81vjEFAcPeugXrHg78Imu55F6gg==", "dev": true, "requires": { - "@typescript-eslint/types": "5.48.0", + "@typescript-eslint/types": "5.50.0", "eslint-visitor-keys": "^3.3.0" }, "dependencies": { @@ -25436,8 +25647,7 @@ "base64-js": { "version": "1.5.1", "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", - "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", - "optional": true + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==" }, "basic-auth": { "version": "2.0.1", @@ -25456,11 +25666,19 @@ "version": "2.2.0", "devOptional": true }, + "bindings": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.5.0.tgz", + "integrity": "sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==", + "optional": true, + "requires": { + "file-uri-to-path": "1.0.0" + } + }, "bl": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", - "optional": true, "requires": { "buffer": "^5.5.0", "inherits": "^2.0.4", @@ -25649,7 +25867,6 @@ "version": "5.7.1", "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz", "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==", - "optional": true, "requires": { "base64-js": "^1.3.1", "ieee754": "^1.1.13" @@ -25860,8 +26077,7 @@ "chownr": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.1.4.tgz", - "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==", - "optional": true + "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==" }, "chrome-trace-event": { "version": "1.0.3", @@ -26001,16 +26217,32 @@ "integrity": "sha512-iBPtljfCNcTKNAto0KEtDfZ3qzjJvqE3aTGZsbhjSBlorqpXJlaWWtPO35D+ZImoC3KWejX64o+yPGxhWSTzfg==", "dev": true }, + "color": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/color/-/color-4.2.3.tgz", + "integrity": "sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==", + "requires": { + "color-convert": "^2.0.1", + "color-string": "^1.9.0" + } + }, "color-convert": { "version": "2.0.1", - "devOptional": true, "requires": { "color-name": "~1.1.4" } }, "color-name": { - "version": "1.1.4", - "devOptional": true + "version": "1.1.4" + }, + "color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "requires": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } }, "color2k": { "version": "1.2.4" @@ -26297,8 +26529,7 @@ "deep-extend": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", - "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", - "dev": true + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==" }, "deep-is": { "version": "0.1.4" @@ -26335,6 +26566,11 @@ "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==" }, + "detect-libc": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.1.tgz", + "integrity": "sha512-463v3ZeIrcWtdgIg6vI6XUncguvr2TnGl4SzDXinkt9mSLpBJKXT3mW6xT3VQdDN11+WVs29pgvivTc4Lp8v+w==" + }, "detect-newline": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", @@ -26576,9 +26812,9 @@ "dev": true }, "eslint": { - "version": "8.31.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.31.0.tgz", - "integrity": "sha512-0tQQEVdmPZ1UtUKXjX7EMm9BlgJ08G90IhWh0PKDCb3ZLsgAOHI8fYSIzYVZej92zsgq+ft0FGsxhJ3xo2tbuA==", + "version": "8.33.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.33.0.tgz", + "integrity": "sha512-WjOpFQgKK8VrCnAtl8We0SUOy/oVZ5NHykyMiagV1M9r8IFpIJX7DduK6n1mpfhlG7T1NLWm2SuD8QB7KFySaA==", "dev": true, "requires": { "@eslint/eslintrc": "^1.4.1", @@ -27152,6 +27388,11 @@ "version": "0.1.2", "devOptional": true }, + "expand-template": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/expand-template/-/expand-template-2.0.3.tgz", + "integrity": "sha512-XYfuKMvj4O35f/pOXLObndIRvyQ+/+6AhODh+OKWj9S9498pHHn/IMszH+gt0fBCRWMNfk1ZSp5x3AifmnI2vg==" + }, "expand-tilde": { "version": "1.2.2", "devOptional": true, @@ -27426,6 +27667,11 @@ "strnum": "^1.0.4" } }, + "fastest-levenshtein": { + "version": "1.0.16", + "resolved": "https://registry.npmjs.org/fastest-levenshtein/-/fastest-levenshtein-1.0.16.tgz", + "integrity": "sha512-eRnCtTTtGZFpQCwhJiUOuxPQWRXVKYDn0b2PeHfXL6/Zi53SLAzAHfVhVWK2AryC/WH05kGfxhFIPvTF0SXQzg==" + }, "fastq": { "version": "1.13.0", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", @@ -27476,6 +27722,12 @@ "token-types": "^5.0.1" } }, + "file-uri-to-path": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", + "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==", + "optional": true + }, "fill-range": { "version": "7.0.1", "requires": { @@ -27679,8 +27931,7 @@ "fs-constants": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs-constants/-/fs-constants-1.0.0.tgz", - "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==", - "optional": true + "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==" }, "fs-exists-sync": { "version": "0.1.0", @@ -27846,6 +28097,11 @@ } } }, + "github-from-package": { + "version": "0.0.0", + "resolved": "https://registry.npmjs.org/github-from-package/-/github-from-package-0.0.0.tgz", + "integrity": "sha512-SyHy3T1v2NUXn29OsWdxmK6RwHD+vkj3v8en8AOBZ1wBQ/hCAQ5bAQTD02kW4W9tUp/3Qh6J8r9EvntiyCmOOw==" + }, "github-slugger": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-2.0.0.tgz", @@ -28298,9 +28554,11 @@ } }, "hot-shots": { - "version": "9.0.0", + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/hot-shots/-/hot-shots-10.0.0.tgz", + "integrity": "sha512-uy/uGpuJk7yuyiKRfZMBNkF1GAOX5O2ifO9rDCaX9jw8fu6eW9QeWC7WRPDI+O98frW1HQgV3+xwjWsZPECIzQ==", "requires": { - "unix-dgram": "2.0.x" + "unix-dgram": "2.x" } }, "hpagent": { @@ -28341,7 +28599,9 @@ } }, "http-cache-semantics": { - "version": "4.1.0" + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", + "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==" }, "http-proxy": { "version": "1.18.1", @@ -28493,8 +28753,7 @@ "version": "2.0.4" }, "ini": { - "version": "1.3.8", - "devOptional": true + "version": "1.3.8" }, "inline-style-parser": { "version": "0.1.1" @@ -31714,8 +31973,7 @@ } }, "minimist": { - "version": "1.2.6", - "devOptional": true + "version": "1.2.6" }, "minimist-options": { "version": "4.1.0", @@ -31749,8 +32007,7 @@ "mkdirp-classic": { "version": "0.5.3", "resolved": "https://registry.npmjs.org/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz", - "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==", - "optional": true + "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==" }, "mockdate": { "version": "3.0.5", @@ -31828,11 +32085,22 @@ "msgpack5": "^3.3.0" } }, + "nan": { + "version": "2.17.0", + "resolved": "https://registry.npmjs.org/nan/-/nan-2.17.0.tgz", + "integrity": "sha512-2ZTgtl0nJsO0KQCjEpxcIr5D+Yv90plTitZt9JBfQvVJDS5seMl3FOvsh3+9CoYWXf/1l5OaZzzF6nDm4cagaQ==", + "optional": true + }, "nanoid": { "version": "3.3.4", "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.4.tgz", "integrity": "sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw==" }, + "napi-build-utils": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/napi-build-utils/-/napi-build-utils-1.0.2.tgz", + "integrity": "sha512-ONmRUqK7zj7DWX0D9ADe03wbwOBZxNAfF20PlGfCWQcD3+/MakShIHrMqx9YwPTfxDdF1zLeL+RGZiR9kGMLdg==" + }, "natural-compare": { "version": "1.4.0", "dev": true @@ -31901,6 +32169,19 @@ "propagate": "^2.0.0" } }, + "node-abi": { + "version": "3.31.0", + "resolved": "https://registry.npmjs.org/node-abi/-/node-abi-3.31.0.tgz", + "integrity": "sha512-eSKV6s+APenqVh8ubJyiu/YhZgxQpGP66ntzUb3lY1xB9ukSRaGnx0AIxI+IM+1+IVYC1oWobgG5L3Lt9ARykQ==", + "requires": { + "semver": "^7.3.5" + } + }, + "node-addon-api": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-5.1.0.tgz", + "integrity": "sha512-eh0GgfEkpnoWDq+VY8OyvYhFEzBk6jIYbRKdIlyTiAXIVJ8PyBaKb0rp7oDtoddbdoHWhq8wwr+XZ81F1rpNdA==" + }, "node-fetch": { "version": "2.6.7", "devOptional": true, @@ -32420,6 +32701,25 @@ "postcss-value-parser": { "version": "4.1.0" }, + "prebuild-install": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/prebuild-install/-/prebuild-install-7.1.1.tgz", + "integrity": "sha512-jAXscXWMcCK8GgCoHOfIr0ODh5ai8mj63L2nWrjuAgXE6tDyYGnx4/8o/rCgU+B4JSyZBKbeZqzhtwtC3ovxjw==", + "requires": { + "detect-libc": "^2.0.0", + "expand-template": "^2.0.3", + "github-from-package": "0.0.0", + "minimist": "^1.2.3", + "mkdirp-classic": "^0.5.3", + "napi-build-utils": "^1.0.1", + "node-abi": "^3.3.0", + "pump": "^3.0.0", + "rc": "^1.2.7", + "simple-get": "^4.0.0", + "tar-fs": "^2.0.0", + "tunnel-agent": "^0.6.0" + } + }, "prelude-ls": { "version": "1.2.1", "dev": true @@ -32700,7 +33000,6 @@ "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", - "dev": true, "requires": { "deep-extend": "^0.6.0", "ini": "~1.3.0", @@ -32711,8 +33010,7 @@ "strip-json-comments": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", - "dev": true + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==" } } }, @@ -33468,9 +33766,9 @@ "integrity": "sha512-ZQruFgZnIWH+WyO9t5rWt4ZEGqCKPwhiw+YbzTwpmT9elgLrLcfuyUiSnwwjUiVy9r4VM3urtbNF1xmEh9IL2w==" }, "semver": { - "version": "7.3.7", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.7.tgz", - "integrity": "sha512-QlYTucUYOews+WeEujDoEGziz4K6c47V/Bd+LjSSYcA94p+DmINdf7ncaUinThfvZyu13lN9OY1XDxt8C0Tw0g==", + "version": "7.3.8", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", + "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", "requires": { "lru-cache": "^6.0.0" } @@ -33630,6 +33928,21 @@ "shallowequal": { "version": "1.1.0" }, + "sharp": { + "version": "0.31.3", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.31.3.tgz", + "integrity": "sha512-XcR4+FCLBFKw1bdB+GEhnUNXNXvnt0tDo4WsBsraKymuo/IAuPuCBVAL2wIkUw2r/dwFW5Q5+g66Kwl2dgDFVg==", + "requires": { + "color": "^4.2.3", + "detect-libc": "^2.0.1", + "node-addon-api": "^5.0.0", + "prebuild-install": "^7.1.1", + "semver": "^7.3.8", + "simple-get": "^4.0.1", + "tar-fs": "^2.1.1", + "tunnel-agent": "^0.6.0" + } + }, "shebang-command": { "version": "2.0.0", "dev": true, @@ -33699,6 +34012,36 @@ "version": "3.0.7", "devOptional": true }, + "simple-concat": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/simple-concat/-/simple-concat-1.0.1.tgz", + "integrity": "sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==" + }, + "simple-get": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/simple-get/-/simple-get-4.0.1.tgz", + "integrity": "sha512-brv7p5WgH0jmQJr1ZDDfKDOSeWWg+OVypG99A/5vYGPqJ6pxiaHLy8nxtFjBA7oMa01ebA9gfh1uMCFqOuXxvA==", + "requires": { + "decompress-response": "^6.0.0", + "once": "^1.3.1", + "simple-concat": "^1.0.0" + } + }, + "simple-swizzle": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz", + "integrity": "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==", + "requires": { + "is-arrayish": "^0.3.1" + }, + "dependencies": { + "is-arrayish": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz", + "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==" + } + } + }, "simple-update-notifier": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/simple-update-notifier/-/simple-update-notifier-1.0.7.tgz", @@ -34115,7 +34458,6 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.1.tgz", "integrity": "sha512-V0r2Y9scmbDRLCNex/+hYzvp/zyYjvFbHPNgVTKfQvVrb6guiE/fxP+XblDNR011utopbkex2nM4dHNV6GDsng==", - "optional": true, "requires": { "chownr": "^1.1.1", "mkdirp-classic": "^0.5.2", @@ -34127,7 +34469,6 @@ "version": "2.2.0", "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-2.2.0.tgz", "integrity": "sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ==", - "optional": true, "requires": { "bl": "^4.0.3", "end-of-stream": "^1.4.1", @@ -34381,6 +34722,14 @@ "integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==", "dev": true }, + "tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w==", + "requires": { + "safe-buffer": "^5.0.1" + } + }, "type-check": { "version": "0.4.0", "dev": true, @@ -34599,6 +34948,16 @@ "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", "optional": true }, + "unix-dgram": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/unix-dgram/-/unix-dgram-2.0.6.tgz", + "integrity": "sha512-AURroAsb73BZ6CdAyMrTk/hYKNj3DuYYEuOaB8bYMOHGKupRNScw90Q5C71tWJc3uE7dIeXRyuwN0xLLq3vDTg==", + "optional": true, + "requires": { + "bindings": "^1.5.0", + "nan": "^2.16.0" + } + }, "unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", diff --git a/package.json b/package.json index f36a39069889..51697bf3dda4 100644 --- a/package.json +++ b/package.json @@ -30,6 +30,7 @@ "dotenv": "^16.0.1", "express": "^4.18.1", "express-timeout-handler": "^2.2.2", + "fastest-levenshtein": "1.0.16", "file-type": "18.2.0", "flat": "^5.0.2", "github-slugger": "^2.0.0", @@ -43,7 +44,7 @@ "helmet": "^6.0.0", "highlight.js": "11.7.0", "highlightjs-curl": "^1.3.0", - "hot-shots": "^9.0.0", + "hot-shots": "^10.0.0", "html-entities": "^2.3.3", "http-proxy-middleware": "2.0.6", "imurmurhash": "^0.1.4", @@ -81,6 +82,7 @@ "rss-parser": "^3.12.0", "scroll-anchoring": "^0.1.0", "semver": "^7.3.7", + "sharp": "0.31.3", "slash": "^5.0.0", "strip-html-comments": "^1.0.0", "styled-components": "^5.3.5", @@ -113,8 +115,8 @@ "@types/react-dom": "^18.0.5", "@types/react-syntax-highlighter": "^15.5.2", "@types/uuid": "^9.0.0", - "@typescript-eslint/eslint-plugin": "5.48.0", - "@typescript-eslint/parser": "5.48.0", + "@typescript-eslint/eslint-plugin": "5.50.0", + "@typescript-eslint/parser": "5.50.0", "babel-loader": "^9.0.1", "babel-plugin-styled-components": "^2.0.7", "babel-preset-env": "^1.7.0", @@ -124,7 +126,7 @@ "cross-env": "^7.0.3", "csp-parse": "0.0.2", "dedent": "^0.7.0", - "eslint": "8.31.0", + "eslint": "8.33.0", "eslint-config-prettier": "^8.5.0", "eslint-config-standard": "^17.0.0", "eslint-plugin-import": "^2.26.0", @@ -184,6 +186,7 @@ "build": "next build", "debug": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon --inspect server.js", "dev": "cross-env npm start", + "fixture-dev": "cross-env ROOT=tests/fixtures npm start", "index-test-fixtures": "node script/search/index-elasticsearch.js -l en -l ja -V ghae -V dotcom --index-prefix tests -- tests/content/fixtures/search-indexes", "lint": "eslint '**/*.{js,mjs,ts,tsx}'", "lint-translation": "cross-env NODE_OPTIONS=--experimental-vm-modules jest tests/linting/lint-files.js", diff --git a/script/copy-fixture-data.js b/script/copy-fixture-data.js new file mode 100755 index 000000000000..ee41029a1d65 --- /dev/null +++ b/script/copy-fixture-data.js @@ -0,0 +1,104 @@ +#!/usr/bin/env node + +// [start-readme] +// +// There are certain files that have to be manually copied from the +// real data into the test fixture data. +// +// This script copies the files from `data/` into `tests/fitures/data/...` +// that are files that are both needed for fixture testing yet can't +// live with the code. For example, `data/ui.yml` is part of the rendering +// code, but it lives in `data/` so it can be translated. +// +// [end-readme] + +import fs from 'fs' +import path from 'path' + +import { program } from 'commander' +import chalk from 'chalk' +import mkdirp from 'mkdirp' + +// Here, write down all the files that are actually part of the rendering +// functionality yet live in data. +const MANDATORY_FILES = [ + 'data/ui.yml', + 'data/reusables/policies/translation.md', + 'data/reusables/enterprise_deprecation/deprecation_details.md', + 'data/reusables/enterprise_deprecation/version_was_deprecated.md', + 'data/reusables/enterprise_deprecation/version_will_be_deprecated.md', + 'data/variables/release_candidate.yml', +] + +const DESTINATION = path.resolve('tests/fixtures') + +program + .description('Make sure the test fixtures have up-to-date data from the real content') + .option('--check', 'Exit non-zero if it had to actually do something') + .option('--dry-run', "Don't actually write changes to disk") + .option('-v, --verbose', 'Verbose outputs') + .parse(process.argv) + +main(program.opts()) + +async function main(opts) { + let errors = 0 + for (const file of MANDATORY_FILES) { + const source = fs.readFileSync(file, 'utf-8') + const destination = path.join(DESTINATION, file) + + if (opts.check) { + // The destination has to exist and be identical + try { + const copied = fs.readFileSync(destination, 'utf-8') + if (copied !== source) { + // console.warn(chalk.red(`The file ${destination} is different from ${file}`)) + console.warn(`The file ${chalk.red(destination)} is different from ${chalk.red(file)}`) + errors++ + } else if (opts.verbose) { + console.log(`The file ${chalk.green(destination)} is up-to-date 🥰`) + } + } catch (error) { + if (error.code === 'ENOENT') { + console.warn(`The file ${chalk.red(destination)} does not exist`) + errors++ + } else { + throw error + } + } + } else { + try { + const copied = fs.readFileSync(destination, 'utf-8') + if (copied === source) { + if (opts.verbose) { + console.log(`The file ${chalk.green(destination)} was perfect already 👌`) + } + continue + } + } catch (error) { + if (error.code !== 'ENOENT') throw error + } + if (!opts.dryRun) { + await mkdirp(path.dirname(destination)) + fs.writeFileSync(destination, source, 'utf-8') + if (opts.verbose) { + console.log(`Copied latest ${chalk.green(file)} to ${chalk.bold(destination)} 👍🏼`) + } + } else if (opts.verbose) { + console.log(`Would copy latest ${chalk.bold(file)} to ${chalk.bold(destination)}`) + } + } + } + + if (errors > 0) { + console.warn( + '\n', + chalk.yellow( + 'Run this script again without --check to make all fixture data files up-to-date. ' + + 'Then commit and check in.' + ) + ) + } + + process.exitCode = errors +} diff --git a/script/create-subject.js b/script/create-subject.js new file mode 100755 index 000000000000..38a4fa5d0792 --- /dev/null +++ b/script/create-subject.js @@ -0,0 +1,72 @@ +#!/usr/bin/env node + +/* Create a new subject folder + +Output looks like: + +src/ + xsubject/ + README.md + components/ + gitkeep + lib/ + tests/ + scripts/ + stylesheets/ + pages/ + docs/ +*/ + +import fs from 'fs/promises' +import { program } from 'commander' + +program + .description('Scaffold a new subject folder under the src/ directory.') + .option('-n, --name