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.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "title": "Get a summary of Copilot usage for a team", - "category": "copilot", - "subcategory": "copilot-usage", - "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" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "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": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.
\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - } - ], "copilot-user-management": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 95dccf72bf..b397590c4a 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -44218,9 +44218,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -240257,7 +240255,7 @@ } ], "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.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
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": "since", - "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "day": "2023-10-15", - "total_suggestions_count": 5000, - "total_acceptances_count": 3000, - "total_lines_suggested": 7000, - "total_lines_accepted": 3500, - "total_active_users": 15, - "total_chat_acceptances": 45, - "total_chat_turns": 350, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3000, - "acceptances_count": 2000, - "lines_suggested": 3000, - "lines_accepted": 1500, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 5200, - "total_acceptances_count": 5100, - "total_lines_suggested": 5300, - "total_lines_accepted": 5000, - "total_active_users": 15, - "total_chat_acceptances": 57, - "total_chat_turns": 455, - "total_active_chat_users": 12, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3100, - "acceptances_count": 3000, - "lines_suggested": 3200, - "lines_accepted": 3100, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1100, - "acceptances_count": 1000, - "lines_suggested": 1200, - "lines_accepted": 1100, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 900, - "lines_suggested": 1100, - "lines_accepted": 1000, - "active_users": 5 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.
\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/usage", - "title": "Get a summary of Copilot usage for an enterprise team", - "category": "copilot", - "subcategory": "copilot-usage", - "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": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.
\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "title": "Get a summary of Copilot usage for organization members", - "category": "copilot", - "subcategory": "copilot-usage", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "title": "Get a summary of Copilot usage for a team", - "category": "copilot", - "subcategory": "copilot-usage", - "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" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "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": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.
\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - } - ], "copilot-user-management": [ { "serverUrl": "https://api.github.com", @@ -590689,12 +589535,20 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "userName": "octocat", - "name": "Monalisa Octocat", + "userName": "mona.octocat@okta.example.com", + "externalId": "a7d0f98382", + "name": { + "givenName": "Monalisa", + "familyName": "Octocat", + "formatted": "Monalisa Octocat" + }, "emails": [ { - "value": "mona.octocat@github.com", + "value": "mona.octocat@okta.example.com", "primary": true + }, + { + "value": "monalisa@octocat.github.com" } ] }, @@ -591502,11 +590356,16 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "userName": "octocat", - "name": "Monalisa Octocat", + "userName": "mona.octocat@okta.example.com", + "externalId": "a7d0f98382", + "name": { + "givenName": "Monalisa", + "familyName": "Octocat", + "formatted": "Monalisa Octocat" + }, "emails": [ { - "value": "mona.octocat@github.com", + "value": "mona.octocat@okta.example.com", "primary": true } ] diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index f4a0b7ba69..510fc792ad 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -39245,9 +39245,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -171396,7 +171394,7 @@ } ], "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.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
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.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
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.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
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.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
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.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.
\nTo list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.
An issue type 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": [ + "typed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
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": "string", + "name": "user_view_type", + "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", + "name": "user_view_type", + "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\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread
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": "string", + "name": "user_view_type", + "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": "object", + "name": "sub_issues_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "total", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "completed", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "percent_completed", + "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": "object or null", + "name": "type", + "description": "The type of issue.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "The description of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "The color of the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time the issue type created.
" + }, + { + "type": "string", + "name": "updated_at", + "description": "The time the issue type last updated.
" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "The enabled state of the issue type.
" + } + ] + }, + { + "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": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "type", + "in": "body", + "description": "The type of issue.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "The description of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "The color of the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time the issue type created.
" + }, + { + "type": "string", + "name": "updated_at", + "description": "The time the issue type last updated.
" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "The enabled state of the issue type.
" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "typed", + "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.
", @@ -81046,6 +82562,1522 @@ ], "action": "unpinned", "category": "issues" + }, + "untyped": { + "descriptionHtml": "An issue type 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": [ + "untyped" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
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": "string", + "name": "user_view_type", + "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", + "name": "user_view_type", + "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\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread
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": "string", + "name": "user_view_type", + "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": "object", + "name": "sub_issues_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "total", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "completed", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "percent_completed", + "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": "object or null", + "name": "type", + "description": "The type of issue.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "The description of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "The color of the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time the issue type created.
" + }, + { + "type": "string", + "name": "updated_at", + "description": "The time the issue type last updated.
" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "The enabled state of the issue type.
" + } + ] + }, + { + "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": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "type", + "in": "body", + "description": "The type of issue.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "The description of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "The color of the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time the issue type created.
" + }, + { + "type": "string", + "name": "updated_at", + "description": "The time the issue type last updated.
" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "The enabled state of the issue type.
" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "untyped", + "category": "issues" } }, "label": { diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index b3e6029fca..e807782de4 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -78772,6 +78772,1522 @@ "action": "transferred", "category": "issues" }, + "typed": { + "descriptionHtml": "An issue type 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": [ + "typed" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
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": "string", + "name": "user_view_type", + "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", + "name": "user_view_type", + "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\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread
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": "string", + "name": "user_view_type", + "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": "object", + "name": "sub_issues_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "total", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "completed", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "percent_completed", + "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": "object or null", + "name": "type", + "description": "The type of issue.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "The description of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "The color of the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time the issue type created.
" + }, + { + "type": "string", + "name": "updated_at", + "description": "The time the issue type last updated.
" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "The enabled state of the issue type.
" + } + ] + }, + { + "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": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "type", + "in": "body", + "description": "The type of issue.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "The description of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "The color of the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time the issue type created.
" + }, + { + "type": "string", + "name": "updated_at", + "description": "The time the issue type last updated.
" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "The enabled state of the issue type.
" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "typed", + "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.
", @@ -84707,6 +86223,1522 @@ ], "action": "unpinned", "category": "issues" + }, + "untyped": { + "descriptionHtml": "An issue type 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": [ + "untyped" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
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": "string", + "name": "user_view_type", + "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", + "name": "user_view_type", + "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\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread
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": "string", + "name": "user_view_type", + "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": "object", + "name": "sub_issues_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "total", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "completed", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "percent_completed", + "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": "object or null", + "name": "type", + "description": "The type of issue.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "The description of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "The color of the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time the issue type created.
" + }, + { + "type": "string", + "name": "updated_at", + "description": "The time the issue type last updated.
" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "The enabled state of the issue type.
" + } + ] + }, + { + "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": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "type", + "in": "body", + "description": "The type of issue.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The unique identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "The node identifier of the issue type.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "The description of the issue type.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "The color of the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time the issue type created.
" + }, + { + "type": "string", + "name": "updated_at", + "description": "The time the issue type last updated.
" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "The enabled state of the issue type.
" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "untyped", + "category": "issues" } }, "label": { diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 06f6a5b3ec..bba2187b40 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "30dd46c371d8e335d32c414f972a800d811966b4" + "sha": "1827b0fbaf32b97302aa43ab28d04497d9990970" } \ No newline at end of file